Los archivos de lectura de entidades (ERF) son representaciones JSON de los objetos de la campaña de un socio que se ponen a disposición a través de Google Cloud Storage.
Los ERF dejaron de estar disponibles en junio de 2021 y desaparecieron el 31 de octubre de 2024. Los ERF ya no se generan. Usa la API de Display & Video 360 para recuperar recursos de Display & Video 360.
En esta guía, se explica cómo migrar de los archivos de lectura de entidades a la API de Display & Video 360 de las siguientes maneras:
- Descripción general de las diferencias entre las dos interfaces
- Comparación de las tablas de ERF con los servicios de API
- Cómo brindar orientación sobre la recuperación de entidades a través de la API
- Cómo reconocer las brechas de datos existentes
- Presenta una asignación de todos los campos de ERF a campos de recursos de API comparables
Descripción general
Cuando se migra de los ERF a la API de Display & Video 360, hay varias diferencias clave que se deben tener en cuenta, como las siguientes:
- Actualidad de los datos. Los ERF se generan a diario y de forma masiva mientras la API recupera la versión más actualizada de un recurso.
- Estructura de recursos: La API usa estructuras JSON diferentes a las de ERF para representar los mismos tipos de recursos. Es posible que algunos recursos, como la configuración de segmentación pública, usen un espacio de ID diferente.
- Método de recuperación. La API de Display &Video 360 solo permite la recuperación de recursos de manera individual, en listas paginadas o a través de transferencias de datos de BigQuery, a diferencia de los archivos JSON sin procesar que proporciona ERF.
- Alcance. A diferencia de los ERF, que tienen el alcance del ID del socio, la mayoría de los recursos de la API tienen el alcance del ID del anunciante. Los recursos incluidos en las respuestas se limitan a los recursos dentro de ese alcance.
Representación de datos de ERF en la API
Los archivos de lectura de entidades se separan en tablas "Públicas" y "Privadas". Las tablas públicas proporcionan información disponible y aplicable a todos los usuarios, como los valores de segmentación. Las tablas privadas proporcionan datos específicos de un socio, como recursos de creatividades o líneas de pedido.
La API de Display &Video 360 no usa esta dicotomía. En cambio, hace que toda esta información se pueda recuperar a través de varios servicios y con diferentes estructuras JSON. En esta sección, se compara la información que se proporciona a través de las tablas de ERF públicas y privadas con la que se pone a disposición a través de los recursos y los servicios de la API de Display & Video 360.
Información pública
Las tablas públicas de ERF proporcionan materiales de referencia para que los usuarios los usen cuando interpreten la configuración de segmentación de sus recursos privados recuperados y asignen la segmentación a través de un subconjunto de versiones de archivos de datos estructurados (SDF) subidos a través de la IU. Estos materiales de referencia son los mismos para todos los usuarios y consisten en un ID numérico, que se usa para la asignación, y detalles más descriptivos, como un nombre visible.
Cuando usas la API de Display & Video 360, la información de referencia de la segmentación se puede recuperar a través del servicio targetingTypes.targetingOptions
. Al igual que las tablas públicas, este servicio proporciona los IDs y los detalles de las opciones de segmentación para un tipo de segmentación específico. Consulta nuestra página existente Establece la segmentación para ver un ejemplo de código que muestra la recuperación del ID de la opción de segmentación.
Tablas y SDF públicas
Antes de la versión 7 de los SDF, los archivos de lectura de entidades y los archivos de datos estructurados usaban el mismo espacio de ID para la configuración de segmentación. Si eres un usuario de SDF que usa las tablas públicas de ERF para interpretar o asignar la configuración de segmentación con SDF, puedes descargar este material de referencia en formato CSV a través de la IU de Display & Video 360.
A partir de la versión 7, los espacios de ID que usa un subconjunto de columnas de archivos de datos estructurados se actualizaron para desacoplar los SDF de los ERF y alinearse aún más con la API de Display & Video 360. Consulta la guía de migración de la versión 7 y la documentación de referencia para obtener más información.
Recursos privados
Las tablas privadas de ERF proporcionan un resumen diario de la configuración actual de los recursos privados que pertenecen a un socio. Debido al gran volumen de recursos que se pueden crear con un solo socio, estos archivos pueden llegar a ser muy grandes y difíciles de descargar y procesar.
En la API, cada tabla privada tiene un servicio correspondiente que proporciona extremos para la recuperación y administración de ese tipo de recurso. Los recursos se pueden recuperar en forma masiva con el método de lista correspondiente de cada servicio. La estructura JSON para cada recurso es diferente en la API en comparación con ERF, ya que utiliza diferentes nombres de campos y recursos compartidos.
Cierta información disponible en la representación de ERF de un recurso, como la configuración de segmentación asignada de un recurso o los sitios de un canal, se representa en la API como elementos secundarios del recurso original y se deben recuperar a través de solicitudes a la API adicionales.
Recuperación de entidades en la API
Los recursos de Display &Video 360 pueden recuperarse mediante solicitudes directas a la API o importaciones automáticas a BigQuery.
Solicitudes directas a la API
Cada tipo de recurso se puede recuperar a través de un servicio de API diferente. Los recursos se pueden recuperar de forma individual o masiva con el método get o list del servicio correspondiente, respectivamente. Entre las propiedades importantes de los métodos de lista de la API de Display & Video 360, se incluyen las siguientes:
- Alcance obligatorio. A diferencia de los ERF, que se definen por socio, la mayoría de los recursos de la API se definen por anunciante. Para recuperar todos los recursos de un tipo, como las líneas de pedido, de un socio, es posible que se requiera una solicitud de lista individual para cada anunciante secundario de ese socio. Las excepciones incluyen los elementos secundarios directos de un socio, como los anunciantes y los canales que pertenecen a socios.
- Paginación. Los métodos de lista de la API emplean la paginación para garantizar que las respuestas tengan un tamaño razonable y limitar la mayoría de las respuestas de solicitudes individuales o páginas a 100 recursos. Si la cantidad de recursos relevantes es mayor que el tamaño de la página, se requieren llamadas consecutivas a la lista para recuperar las páginas posteriores de la respuesta de la lista completa. En una sección de nuestra página de la guía de segmentación sobre la recuperación de opciones de segmentación disponibles , se proporciona un ejemplo de código para paginar una respuesta de lista.
- Se requieren solicitudes adicionales para recuperar la segmentación. La configuración de segmentación de un recurso no se incluye en su objeto JSON de la API, sino que son recursos secundarios conocidos como opciones de segmentación asignadas. Estos recursos secundarios se deben recuperar a través de una solicitud independiente. Por ejemplo, para cada línea de pedido recuperada a través de una solicitud
advertisers.lineItems.list
, se debe realizar una solicitudadvertisers.lineItems.bulkListAssignedTargetingOptions
independiente para recuperar toda la información de segmentación.
Optimiza la recuperación de recursos
Es posible que la API de Display & Video 360 requiera varias solicitudes para recuperar la misma cantidad de información que está disponible en un solo archivo de lectura de entidades. Optimizar la forma en que recuperas los recursos puede ayudarte a recuperar los datos que necesitas de forma más eficiente:
- Realiza solicitudes simultáneas a la API. La API de Display &Video 360 protege la infraestructura con límites de frecuencia de solicitudes por anunciante y por proyecto. Esta estructura de cuota te permite implementar una solución de varios subprocesos en varios anunciantes que reducirá el tiempo total que se tarda en recuperar todos los recursos necesarios. Aunque la paginación requiere que todos los recursos de un tipo dentro de un determinado alcance se recuperen a través de llamadas consecutivas, la recuperación de recursos dentro de otro alcance o de otro tipo se puede realizar de forma simultánea.
- Usa filtros y orden por parámetros en tus llamadas a la lista para recuperar solo los recursos relevantes. Por ejemplo, si solo te interesan las líneas de pedido que se actualizaron el último día, puedes usar el parámetro
filter
del métodoadvertisers.lineItems.list
para mostrar solo las líneas de pedido con unupdateTime
mayor que una marca de tiempo determinada. Esto puede reducir de manera significativa la cantidad de solicitudes que se deben realizar. - Caché los IDs que se usan con frecuencia para evitar solicitudes innecesarias a la API. Cierta información de referencia, como los IDs de opciones de segmentación y los IDs de Google Audience, son relativamente estables y se pueden almacenar de forma segura para evitar la necesidad de recuperarlos cada vez que se usan. Sin embargo, los valores almacenados en caché deben verificarse semanalmente para tener en cuenta los cambios o las bajas poco frecuentes.
Consulta nuestra guía de optimización de cuotas para obtener más información sobre cómo acceder a la API de Display &Video 360 de manera eficiente.
Importa a BigQuery
El conector de BigQuery de la API de Display & Video 360 te permite importar automáticamente configuraciones de recursos de Display & Video 360 directamente a BigQuery todos los días. Las configuraciones se almacenan en BigQuery con el diseño de recursos de la API de Display & Video 360. Se admite un subconjunto de recursos de API.
Consulta la siguiente documentación de Cloud para obtener más información sobre el uso del conector de BigQuery de la API de Display & Video 360:
- ¿Qué es un Servicio de transferencia de datos de BigQuery?
- Programa una transferencia de Display & Video 360
- Transformación de datos de Display & Video 360
Brechas conocidas en los datos de la API
Existen notables brechas de datos que podrías encontrar cuando migres de ERF a la API de Display & Video 360, como las siguientes:
- Pedidos de inserción de historias. Los pedidos de inserción de historias no se pueden recuperar a través de la API y deben recuperarse a través de la IU de Display & Video 360.
- Un subconjunto de campos de recursos. Una pequeña cantidad de campos de recursos presentes en los objetos ERF no están disponibles en los recursos correspondientes recuperados a través de la API de Display &Video 360.
Apéndice: Asignación de campos de ERF a la API
Asignación de tablas públicas
En las siguientes tablas, se asignan los campos de las tablas públicas de ERF a los tipos de segmentación y campos de opciones de segmentación existentes en la API de Display & Video 360. Aunque el valor de un campo pueda asignarse a otro, eso no garantiza que usen el mismo tipo de datos, valores de enumeración o espacio de ID.
Colección de apps
Se puede recuperar en el tipo de segmentación TARGETING_TYPE_APP_CATEGORY
.
Nombre del campo ERF | Disponibilidad de la API de DV360 |
---|---|
id |
TargetingOption.targetingOptionId
.
|
nombre |
TargetingOption.appCategoryDetails.displayName
.
|
Navegador
Se puede recuperar en el tipo de segmentación TARGETING_TYPE_BROWSER
.
Nombre del campo de ERF | Disponibilidad de la API de DV360 |
---|---|
id |
TargetingOption.targetingOptionId
.
|
is_mobile | No disponible. |
nombre |
TargetingOption.browserDetails.displayName
.
|
DataPartner
No hay recursos ni campos equivalentes disponibles en la API de Display & Video 360.
DeviceCriteria
Se puede recuperar en los tipos de segmentación TARGETING_TYPE_OPERATING_SYSTEM
, TARGETING_TYPE_DEVICE_MAKE_MODEL
y TARGETING_TYPE_DEVICE_TYPE
.
Nombre del campo ERF | Disponibilidad de la API de DV360 |
---|---|
id |
Campo
TargetingOption.targetingOptionId
o enumeración
DeviceType
|
is_mobile | No disponible. |
nombre |
Campo
TargetingOption.operatingSystemDetails.displayName
, campo
TargetingOption.deviceMakeModelDetails.displayName
o enumeración
DeviceType
, según el tipo de segmentación
|
criteria_type |
TargetingOption.targetingType
.
|
operating_system_id | No disponible. |
mobile_brand_name | No disponible. |
mobile_model_name | No disponible. |
mobile_make_model_id | No disponible. |
device_type |
DeviceType
enum.
|
GeoLocation
Se puede recuperar en el tipo de segmentación TARGETING_TYPE_GEO_REGION
.
Nombre del campo de ERF | Disponibilidad de la API de DV360 |
---|---|
id |
TargetingOption.targetingOptionId
.
|
canonical_name |
TargetingOption.geoRegionDetails.displayName
.
|
geo_name | No disponible. |
country_code | No disponible. |
region_code | No disponible. |
city_name | No disponible. |
postal_name | No disponible. |
dma_code | No disponible. |
Isp
Se puede recuperar en el tipo de segmentación TARGETING_TYPE_CARRIER_AND_ISP
.
Nombre del campo de ERF | Disponibilidad de la API de DV360 |
---|---|
id |
TargetingOption.targetingOptionId
.
|
is_mobile | No disponible. |
nombre |
TargetingOption.carrierAndIspDetails.displayName
.
|
secondary_criteria_id |
TargetingOption.targetingOptionId
.
|
Idioma
Se puede recuperar en el tipo de segmentación TARGETING_TYPE_LANGUAGE
.
Nombre del campo de ERF | Disponibilidad de la API de DV360 |
---|---|
id |
TargetingOption.targetingOptionId
.
|
nombre | No disponible. El nombre visible completo de un idioma está disponible en el campo
TargetingOption.languageDetails.displayName
.
|
SiteToPlacementId
No hay recursos ni campos equivalentes disponibles en la API de Display &Video 360.
SupportedExchange
Se puede recuperar en el tipo de segmentación TARGETING_TYPE_EXCHANGE
.
Nombre del campo de ERF | Disponibilidad de la API de DV360 |
---|---|
id |
Exchange
enum.
|
nombre |
Exchange
enum.
|
UniversalSite
No hay recursos ni campos equivalentes disponibles en la API de Display &Video 360. Los sitios y las apps individuales se pueden segmentar directamente en los tipos de segmentación TARGETING_TYPE_URL
y TARGETING_TYPE_APP
, respectivamente.
En Display & Video 360, se puede segmentar cualquier app o URL, pero no se pueden generar informes sobre todas ellas. Si deseas quitar de la inversión las URLs y las apps que no se pueden informar, sigue las instrucciones del Centro de ayuda de DV360.
Asignación de campos de tablas privadas
En las siguientes tablas, se asignan los campos de las tablas privadas de ERF a campos o servicios existentes en la API de Display & Video 360. Aunque el valor de un campo puede asignarse a otro, eso no garantiza que usen el mismo tipo de datos, valores de enumeración o espacio de ID.
Anunciante
Nombre del campo de ERF | Disponibilidad de la API de 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
.
|
currency_code |
Advertiser.generalConfig.currencyCode
.
|
timezone_code |
Advertiser.generalConfig.timeZone
.
|
landing_page_url |
Advertiser.generalConfig.domainUrl
.
|
available_channel_ids | Se puede recuperar a través del método
advertisers.channels.list
.
|
blacklist_channel_id | Se puede recuperar a través del método
advertisers.targetingTypes.assignedtargetingOptions.list
en el tipo de segmentación
TARGETING_TYPE_CHANNEL
. Si
AssignedTargetingOption.channelDetails.negative
es verdadero, el canal tiene segmentación negativa.
|
dcm_configuration | No disponible. |
dcm_network_id |
Advertiser.adServerConfig.cmHybridConfig.cmAccountId
.
|
dcm_advertiser_id |
En el campo
Advertiser.adServerConfig.cmHybridConfig.cmAdvertiserIds
, se enumeran los IDs del anunciante de CM360 que comparten la configuración de Floodlight de CM360.
|
dcm_floodlight_group_id |
Advertiser.adServerConfig.cmHybridConfig.cmFloodlightConfigId
.
|
dcm_syncable_site_ids |
Advertiser.adServerConfig.cmHybridConfig.cmSyncableSiteIds
.
|
enable_oba_tags | No disponible. |
Campaña
Nombre del campo de ERF | Disponibilidad de la API de DV360 |
---|---|
common_data.id |
Campaign.campaignId
.
|
common_data.name |
Campaign.displayName
.
|
common_data.active |
Campaign.entityStatus
.
|
common_data.integration_code | No disponible. |
advertiser_id |
Campaign.advertiserId
.
|
presupuesto |
Campos
Campaign.campaignFlight
y
Campaign.campaignBudgets
.
|
frequency_cap |
Campaign.frequencyCap
.
|
default_target_list | Se puede recuperar a través del método
advertisers.campaigns.bulkListCampaignAssignedTargetingOptions
.
|
uses_video_creatives | No disponible. |
uses_display_creatives | No disponible. |
uses_audio_creatives | No disponible. |
objetivo |
Campaign.campaignGoal.campaignGoalType
.
|
métrica |
Campaign.campaignGoal.performanceGoal.performanceGoalType
.
|
objective_description |
Campaign.campaignGoal.performanceGoal.performanceGoalString
.
|
metric_amount_micros |
Campaign.campaignGoal.performanceGoal.performanceGoalAmountMicros
.
|
Creatividad
Nombre del campo de ERF | Disponibilidad de la API de DV360 |
---|---|
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
.
|
width_pixels |
Creative.dimensions.widthPixels
.
|
height_pixels |
Creative.dimensions.heightPixels
.
|
approval_status |
Creative.reviewStatus
.
|
expanding_direction |
Creative.expandingDirection
.
|
creative_type |
Creative.creativeType
.
|
CustomAffinity
Nombre del campo de ERF | Disponibilidad de la API de DV360 |
---|---|
id |
CustomList.customListId
.
|
nombre |
CustomList.displayName
.
|
descripción | No disponible. |
advertiser_id | No disponible. |
FloodlightActivity
Nombre del campo de ERF | Disponibilidad de la API de DV360 |
---|---|
common_data.id |
FloodlightActivity.floodlightActivityId
.
|
common_data.name |
FloodlightActivity.displayName
.
|
common_data.active |
FloodlightActivity.servingStatus
.
|
common_data.integration_code | No disponible. |
advertiser_id |
En el campo
FloodlightActivity.advertiserIds
, se enumeran todos los anunciantes que tienen acceso a la actividad de Floodlight del socio determinado.
|
partner_id | El usuario lo proporciona cuando realiza una solicitud al servicio floodlightGroups.floodlightActivities . |
remarketing_enabled |
En el campo
FloodlightActivity.remarketingConfigs
, se muestra esta configuración para cada anunciante que tenga acceso a la actividad de Floodlight en el socio determinado.
|
ssl_required |
FloodlightActivity.sslRequired
.
|
InsertionOrder
Nombre del campo de ERF | Disponibilidad de la API de DV360 |
---|---|
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
.
|
overall_budget | No disponible. Se puede calcular con el contenido del campo
InsertionOrder.budget.budgetSegments
.
|
scheduled_segments |
InsertionOrder.budget.budgetSegments
.
|
frequency_cap |
InsertionOrder.frequencyCap
.
|
default_partner_costs |
InsertionOrder.partnerCosts
.
|
default_target_list | Se puede recuperar a través del método
advertisers.insertionOrders.bulkListInsertionOrderAssignedTargetingOptions
.
|
InventorySource
Nombre del campo ERF | Disponibilidad de la API de DV360 |
---|---|
id |
InventorySource.inventorySourceId
.
|
sin clasificar | No disponible. |
inventory_name |
InventorySource.displayName
.
|
exchange_id |
InventorySource.exchange
.
|
accessing_advertisers |
Campos
InventorySource.readWriteAccessors
y
InventorySource.readAdvertiserIds
.
|
external_id |
InventorySource.dealId
.
|
min_cpm_micros |
InventorySource.rateDetails.rate.nanos
, según el valor del campo
InventorySource.rateDetails.inventorySourceRateType
.
|
min_cpm_currency_code |
InventorySource.rateDetails.rate.currencyCode
.
|
LineItem
NegativeKeywordList
Nombre del campo de ERF | Disponibilidad de la API de DV360 |
---|---|
id |
NegativeKeywordList.negativeKeywordListId
.
|
nombre |
NegativeKeywordList.displayName
.
|
advertiser_id |
NegativeKeywordList.advertiserId
.
|
Socio
Nombre del campo ERF | Disponibilidad de la API de DV360 |
---|---|
common_data.id |
Partner.partnerId
.
|
common_data.name |
Partner.displayName
.
|
common_data.active |
Partner.entityStatus
.
|
common_data.integration_code | No disponible. |
currency_code |
Partner.generalConfig.currencyCode
.
|
exchange_settings |
Partner.exchangeConfig.enabledExchanges
.
|
default_partner_costs | No disponible. |
default_partner_revenue | No disponible. |
default_target_list | No disponible. |
Pixel
No hay recursos ni campos equivalentes disponibles en la API de Display & Video 360.
UniversalChannel
Nombre del campo ERF | Disponibilidad de la API de DV360 |
---|---|
id |
Channel.channelId
.
|
nombre |
Channel.displayName
.
|
site_ids | Se puede recuperar a través de los métodos
advertisers.channels.sites.list
y
partners.channels.sites.list
, según el tipo de
owner
.
|
accessing_advertisers | No disponible. |
is_deleted | No disponible. |
is_brand_safe_channel | No disponible. |
UserList
Nombre del campo de ERF | Disponibilidad de la API de DV360 |
---|---|
id |
FirstAndThirdPartyAudience.firstAndThirdPartyAudienceId
.
|
nombre |
FirstAndThirdPartyAudience.displayName
.
|
data_partner_id | No disponible. |
accessing_advertisers | No disponible. |
partner_pricing | No disponible. |
advertiser_pricings | No disponible. |