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. Dado el de esta nueva versión, planeamos anunciar pronto una fecha de retiro de la versión 1.1. Mié Recomendamos que comience la migración de la versión 1.1 a la 2 lo antes posible.

Migra tu aplicación

Para migrar de la versión 1.1 a la v2, es necesario actualizar las URLs de tu extremo para llamar a la v2. actualizando tu aplicación para dar cuenta de los cambios rotundos.

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

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

Identificar métodos equivalentes

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

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

• Los servicios Queries y Reports en la versión 1.1 son conocidos como queries y queries.reports en la v2.
• Se cambió el nombre de los métodos de la siguiente manera en la versión 2:

  Nombre del método v1.1	Método v2 equivalente
  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

Actualizar a extremos nuevos

Una vez que hayas identificado métodos equivalentes, deberás actualizar tus solicitudes. Para Por ejemplo, para llamar al método queries.getquery con v1.1, debes usar 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 la siguiente URL:

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

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

Realiza los cambios necesarios

Presentamos varios cambios rotundos en la versión 2. Revisa lo siguiente instrucciones y realizar los cambios necesarios que sean relevantes para su uso actual del API de Bid Manager.

Actualiza las llamadas al servicio de queries

• Los siguientes campos del recurso Query se representaban originalmente como Los objetos anidados cambiaron para usar los siguientes tipos de objetos:

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

• Los siguientes campos del recurso Query se representaban originalmente como Los objetos list cambiaron y ahora son listas de los siguientes tipos de objetos nuevos:

  Campo de lista de la versión 1.1	Tipo de objeto v2
  params.filters[]	FilterPair
  params.options.pathQueryOptions.channelGrouping.rules[]	Rule
  params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[]	DisjunctiveMatchStatement
  params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[]	EventFilter
  params.options.pathQueryOptions.pathFilters[]	PathFilter
  params.options.pathQueryOptions.pathFilters[].eventFilters[]	EventFilter

• Los siguientes campos del recurso Query, representados originalmente por se representan con tipos de enumeración en la v2 y se incluyen los siguientes: cambios:
  • El equivalente v2 de metadata.dataRange ahora usa Range. enum. Con la conversión a esta enumeración, se generó el valor PREVIOUS_HALF_MONTH se quitó y se cambió el valor TYPE_NOT_SUPPORTED a RANGE_UNSPECIFIED
  • metadata.format ahora usa la enumeración Format. Durante una conversión a esta enumeración, se quitó el valor EXCEL_CSV y el valor Se agregó FORMAT_UNSPECIFIED.
  • params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match y params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match ahora usa la enum 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. En convirtiendo a esta enumeración, se agregó el valor FREQUENCY_UNSPECIFIED.
  • params.type ahora usa la enumeración ReportType. En convirtiendo a esta enumeración, se realizaron los siguientes cambios:
  • Los siguientes valores dejaron de estar disponibles:
    • 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
  • Todos los valores restantes se actualizaron para reflejar mejor su 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

• Campos metadata.dataRange, reportDataStartTimeMs y reportDataEndTimeMs se reemplazaron por campos range, customStartDate y customEndDate. Los nuevos campos de fecha usan Date en lugar de milisegundos, desde Unix Epoch. Estos campos de reemplazo se movieron al objeto DataRange asignado al campo dataRange de la objeto QueryMetadata.
• Los campos schedule.startTimeMs y schedule.endTimeMs se reemplazaron por campos startDate y endDate en el objeto QuerySchedule. Los nuevos campos de fecha usan Date en lugar de milisegundos, desde Unix Epoch.
• Campos metadata.running, metadata.reportCount, metadata.googleCloudStoragePathForLatestReport, metadata.googleDrivePathForLatestReport y Se quitaron metadata.latestReportRunTimeMs. La información sobre los informes generados más recientemente de una consulta debe en su lugar, se lo recuperará mediante el método queries.reports.list con la Parámetro de consulta orderBy de “key.reportId desc” a garantizar que la solicitud enumere primero los informes más recientes.
• Campos kind, timezoneCode, metadata.locale, params.includeInviteData y Se quitaron schedule.nextRunMinuteOfDay.
• queries.create ya no ejecuta consultas automáticamente después de su creación y se quitó el parámetro de consulta asynchronous. Llamada queries.run después de queries.create para generar informes de 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 funciona con una lógica inversa y se considera falso si no se especifica. Proporcionado Esto, queries.run genera informes de forma asíncrona y predeterminada en v2 en lugar de la síncrona, que es la opción predeterminada en la v1.1.
  • El cuerpo de la solicitud se actualizó para quitar la campo timezoneCode y reemplazar dataRange, reportDataStartTimeMs reportDataEndTimeMs con un DataRange asignado al dataRange.
  • El método muestra el objeto Report resultante en lugar de un cuerpo de respuesta vacío.
• El campo kind en el cuerpo de la respuesta queries.list se ha eliminado.

Actualiza las llamadas al servicio de reports

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

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

• Los siguientes campos del recurso Report representados originalmente por los objetos de lista general cambiaron y ahora son listas del siguiente objeto nuevo tipos:

  Campo de lista de la versión 1.1	Tipo de objeto v2
  params.filters[]	FilterPair
  params.options.pathQueryOptions.channelGrouping.rules[]	Rule
  params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[]	DisjunctiveMatchStatement
  params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[]	EventFilter
  params.options.pathQueryOptions.pathFilters[]	PathFilter
  params.options.pathQueryOptions.pathFilters[].eventFilters[]	EventFilter

• Los siguientes campos del recurso Report representados originalmente por cadenas han cambiado, por lo que sus campos equivalentes en la v2 están representados por nuevos los tipos enum e incluir cambios en valores aceptables:
  • metadata.status.format ahora usa la enumeración Format. En convirtiendo a esta enumeración, se quitó el valor EXCEL_CSV Se agregó FORMAT_UNSPECIFIED.
  • metadata.status.state ahora usa la enumeración State. En convirtiendo a esta enumeración, los valores QUEUED y STATE_UNSPECIFIED tienen se agregó.
  • params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match y params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match ahora usa la enum 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. En convirtiendo a esta enumeración, se realizaron muchos cambios y se enumeran en en la sección anterior sobre la actualización de las llamadas de servicio de consultas.
• Los campos metadata.reportDataStartTimeMs y metadata.reportDataEndTimeMs se reemplazaron por campos reportDataStartDate y reportDataEndDate en las objeto ReportMetadata. Los campos nuevos usan Objetos Date en lugar de milisegundos a partir de la época Unix.
• metadata.status.finishTimeMs se reemplazó por el campo finishTime en la objeto ReportStatus. Este nuevo campo de tiempo representa la fecha y hora como una marca de tiempo en RFC3339 UTC "Zulú" en lugar de en milisegundos desde la época Unix.
• metadata.status.failure y Se quitaron params.includeInviteData campos.
• El campo kind en el cuerpo de la respuesta reports.list tiene se ha eliminado.

Actualiza la lógica de manejo de errores

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