Migre de la API de Bid Manager de la versión 1.1 a la versión 2

En marzo de 2022, lanzamos la versión 2 de la API de Bid Manager. Debido al lanzamiento de esta nueva versión, planeamos anunciar pronto una fecha de baja para la v1.1. Te recomendamos que comiences la migración de la v1.1 a la v2 lo antes posible.

Migra tu aplicación

Para migrar de la v1.1 a la v2, debes actualizar las URLs de tus extremos para llamar a la v2 y actualizar tu aplicación para tener en cuenta los cambios rotundos.

Actualiza tus llamadas a la API de la v1.1 a la v2

Para usar la v2 en lugar de la v1.1, debes actualizar tus solicitudes para usar los nuevos extremos de la v2.

Identifica los métodos equivalentes

Para actualizar tus llamadas a la API de la v1.1 a la v2, primero debes identificar los métodos equivalentes de la v1.1 en la v2.

Los siguientes nombres de todos los servicios y métodos cambiaron ligeramente entre la v1.1 y la v2:

• Los servicios Queries y Reports de la v1.1 se conocen como queries y queries.reports en la v2.
• Los métodos cambiaron de nombre de la siguiente manera en la v2:

  Nombre del método de la v1.1	Método equivalente de la v2
  Queries.createquery	queries.create
  Queries.deletequery	queries.delete
  Queries.getquery	queries.get
  Queries.listqueries	queries.list
  Queries.runquery	queries.run
  Reports.listreports	queries.reports.list

Actualiza a los extremos nuevos

Una vez que hayas identificado los métodos equivalentes, deberás actualizar tus solicitudes. Por ejemplo, para llamar al queries.getquery método con la v1.1, usarías la siguiente URL:

https://www.googleapis.com/doubleclickbidmanager/v1.1/query/queryId

Para llamar al método equivalente en la v2, conocido como queries.get, actualiza la URL a lo siguiente:

GET https://doubleclickbidmanager.googleapis.com/v2/queries/queryId

Si usas una biblioteca cliente para realizar solicitudes a la API, usa la versión más reciente de la biblioteca cliente y actualiza tu configuración para usar la v2.

Realiza los cambios necesarios

Presentamos varios cambios rotundos en la v2. Revisa las siguientes instrucciones y realiza los cambios necesarios pertinentes a tu uso existente de la API de Bid Manager.

Actualiza las llamadas al servicio queries

• Los siguientes campos del recurso Query que originalmente estaban representados por objetos anidados generales cambiaron para usar los siguientes tipos de objetos:

  Campo de la v1.1	Tipo de objeto equivalente de la v2
  metadata	QueryMetadata
  params	Parameters
  params.options	Options
  params.options.pathQueryOptions	Quitado
  params.options.pathQueryOptions.channelGrouping	Quitado
  params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter	Quitado
  params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter	Quitado
  schedule	QuerySchedule

• Los siguientes campos del recurso Query que originalmente estaban representados por objetos de lista generales cambiaron para ser listas de los siguientes tipos de objetos nuevos:

  Campo de lista de la v1.1	Tipo de objeto de la v2
  params.filters[]	FilterPair
  params.options.pathQueryOptions.channelGrouping.rules[]	Quitado
  params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[]	Quitado
  params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[]	Quitado
  params.options.pathQueryOptions.pathFilters[]	Quitado
  params.options.pathQueryOptions.pathFilters[].eventFilters[]	Quitado

• Los siguientes campos del recurso Query, que originalmente estaban representados por cadenas, ahora están representados por tipos de enumeración en la v2 e incluyen los siguientes cambios:
  • El equivalente de metadata.dataRange en la v2 ahora usa la Range enumeración. Al realizar la conversión a esta enumeración, se quitó el valor PREVIOUS_HALF_MONTH y se cambió el valor TYPE_NOT_SUPPORTED a RANGE_UNSPECIFIED.
  • metadata.format ahora usa la enumeración Format. Al realizar la conversión a esta enumeración, se quitó el valor EXCEL_CSV y se agregó el valor FORMAT_UNSPECIFIED.
  • params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match y params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match ahora usan la enumeración Match.
  • params.options.pathQueryOptions.pathFilters[].pathMatchPosition ahora usa la enumeración PathMatchPosition. Al realizar la conversión a esta enumeración, se agregó el valor PATH_MATCH_POSITION_UNSPECIFIED.
  • schedule.frequency ahora usa la enumeración Frequency. Al realizar la conversión a esta enumeración, se agregó el valor FREQUENCY_UNSPECIFIED.
  • params.type ahora usa la enumeración ReportType. Al realizar la conversión a esta enumeración, se realizaron los siguientes cambios:
  • Se dejaron de usar los siguientes valores:
    • TYPE_ACTIVE_GRP
    • TYPE_AUDIENCE_PERFORMANCE
    • TYPE_CLIENT_SAFE
    • TYPE_COMSCORE_VCE
    • TYPE_CROSS_FEE
    • TYPE_CROSS_PARTNER
    • TYPE_CROSS_PARTNER_THIRD_PARTY_DATA_PROVIDER
    • TYPE_ESTIMATED_CONVERSION
    • TYPE_FEE
    • TYPE_KEYWORD
    • TYPE_LINEAR_TV_SEARCH_LIFT
    • TYPE_NIELSEN_AUDIENCE_PROFILE
    • TYPE_NIELSEN_DAILY_REACH_BUILD
    • TYPE_NIELSEN_ONLINE_GLOBAL_MARKET
    • TYPE_PAGE_CATEGORY
    • TYPE_PETRA_NIELSEN_DAILY_REACH_BUILD
    • TYPE_PETRA_NIELSEN_ONLINE_GLOBAL_MARKET
    • TYPE_PIXEL_LOAD
    • TYPE_THIRD_PARTY_DATA_PROVIDER
    • TYPE_TRUEVIEW_IAR
    • TYPE_VERIFICATION
    • TYPE_YOUTUBE_VERTICAL
  • Se actualizaron todos los valores restantes para reflejar mejor sus valores equivalentes en la IU:

    Valores de la v1.1	Valor ReportType equivalente
    TYPE_NOT_SUPPORTED	REPORT_TYPE_UNSPECIFIED
    TYPE_GENERAL	STANDARD
    TYPE_INVENTORY_AVAILABILITY	INVENTORY_AVAILABILITY
    TYPE_AUDIENCE_COMPOSITION	AUDIENCE_COMPOSITION
    TYPE_ORDER_ID	FLOODLIGHT
    TYPE_TRUEVIEW	YOUTUBE
    TYPE_NIELSEN_SITE	GRP
    TYPE_PETRA_NIELSEN_AUDIENCE_PROFILE	YOUTUBE_PROGRAMMATIC_GUARANTEED
    TYPE_REACH_AND_FREQUENCY	REACH
    TYPE_REACH_AUDIENCE	UNIQUE_REACH_AUDIENCE
    TYPE_PATH	FULL_PATH
    TYPE_PATH_ATTRIBUTION	PATH_ATTRIBUTION

• Los campos metadata.dataRange, reportDataStartTimeMs y reportDataEndTimeMs se reemplazaron por los campos range, customStartDate y customEndDate. Los nuevos campos de fecha usan Date objetos en lugar de milisegundos desde la época de Unix. Estos campos de reemplazo se movieron al objeto DataRange asignado al campo dataRange en el objeto QueryMetadata.
• Los campos schedule.startTimeMs y schedule.endTimeMs se reemplazaron por los campos startDate y endDate en el objeto QuerySchedule. Los nuevos campos de fecha usan Date objetos en lugar de milisegundos desde la época de Unix.
• Se quitaron los campos metadata.running, metadata.reportCount, metadata.googleCloudStoragePathForLatestReport, metadata.googleDrivePathForLatestReport y metadata.latestReportRunTimeMs. En su lugar, la información sobre los informes generados más recientemente de una consulta se debe recuperar con el método queries.reports.list con el parámetro de consulta orderBy de “key.reportId desc” para garantizar que la solicitud enumere primero los informes más recientes.
• Se quitaron los campos kind, timezoneCode, metadata.locale, params.includeInviteData y schedule.nextRunMinuteOfDay.
• queries.create ya no ejecuta automáticamente las consultas después de la creación y se quitó el parámetro de consulta asynchronous. Llama queries.run después de queries.create para generar informes para las consultas nuevas.
• El método queries.run se actualizó de las siguientes maneras:
  • El parámetro de consulta asynchronous se reemplazó por el parámetro de consulta synchronous. El nuevo parámetro de consulta opera con lógica inversa y se considera falso si no se especifica. Por lo tanto, esto, queries.run genera informes de forma asíncrona de forma predeterminada en la v2, en lugar de síncrona, que es el valor predeterminado en la v1.1.
  • Se actualizó el cuerpo de la solicitud para quitar el timezoneCode campo y reemplazar los dataRange, reportDataStartTimeMs y reportDataEndTimeMs campos por un objeto DataRange asignado al campo dataRange.
  • El método muestra el objeto Report resultante en lugar de un cuerpo de respuesta vacío.
• Se quitó el campo kind del cuerpo de respuesta de queries.list.

Actualiza las llamadas al servicio reports

• Los siguientes campos del recurso Report que originalmente estaban representados por objetos anidados generales cambiaron para usar los siguientes tipos de objetos:

  Campo de la v1.1	Tipo de objeto equivalente de la v2
  key	ReportKey
  metadata	ReportMetadata
  metadata.status	ReportStatus
  params	Parameters
  params.options	Options
  params.options.pathQueryOptions	Quitado
  params.options.pathQueryOptions.channelGrouping	Quitado
  params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter	Quitado
  params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter	Quitado

• Los siguientes campos del recurso Report que originalmente estaban representados por objetos de lista generales cambiaron para ser listas de los siguientes tipos de objetos nuevos:

  Campo de lista de la v1.1	Tipo de objeto de la v2
  params.filters[]	FilterPair
  params.options.pathQueryOptions.channelGrouping.rules[]	Quitado
  params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[]	Quitado
  params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[]	Quitado
  params.options.pathQueryOptions.pathFilters[]	Quitado
  params.options.pathQueryOptions.pathFilters[].eventFilters[]	Quitado

• Los siguientes campos del recurso Report que originalmente estaban representados por cadenas cambiaron para que sus campos equivalentes en la v2 estén representados por tipos de enumeración nuevos e incluyan cambios en los valores aceptables:
  • metadata.status.format ahora usa la enumeración Format. Al realizar la conversión a esta enumeración, se quitó el valor EXCEL_CSV y se agregó el valor FORMAT_UNSPECIFIED.
  • metadata.status.state ahora usa la enumeración State. Al realizar la conversión a esta enumeración, se agregaron los valores QUEUED y STATE_UNSPECIFIED.
  • params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match y params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match ahora usan la enumeración Match.
  • params.options.pathQueryOptions.pathFilters[].pathMatchPosition ahora usa la enumeración PathMatchPosition. Al realizar la conversión a esta enumeración, se agregó el valor PATH_MATCH_POSITION_UNSPECIFIED.
  • params.type ahora usa la enumeración ReportType. Al realizar la conversión a esta enumeración, se realizaron varios cambios que se enumeran en detalle en la sección anterior sobre la actualización de las llamadas al servicio de consultas.
• Los campos metadata.reportDataStartTimeMs y metadata.reportDataEndTimeMs se reemplazaron por los campos reportDataStartDate y reportDataEndDate en el ReportMetadata objeto. Los nuevos campos usan Date objetos en lugar de milisegundos desde la época de Unix.
• metadata.status.finishTimeMs se reemplazó por el campo finishTime en el objeto ReportStatus. Este nuevo campo de hora representa la fecha y hora como una marca de tiempo en formato RFC3339 UTC “Zulu” en lugar de en milisegundos desde la época de Unix.
• Se quitaron los campos metadata.status.failure y params.includeInviteData.
• Se quitó el campo kind del cuerpo de respuesta de reports.list que se quitó.

Actualiza la lógica de manejo de errores

Se actualizaron los mensajes de error en toda la API en la v2. Estos nuevos mensajes de error son más específicos y, en algunos casos, proporcionan información sobre los valores de la solicitud a la API que causan que se muestre el error. Si tu lógica de manejo de errores existente se basa en texto específico del mensaje de error, generaliza el manejo de errores antes de migrar a la v2.