Questa pagina è stata tradotta dall'API Cloud Translation.

Eseguire la migrazione dalla versione 1.1 alla v2 dell'API di Bid Manager

A marzo 2022 abbiamo rilasciato la versione 2 dell'API Bid Manager. Data la release di questa nuova versione, prevediamo di annunciare a breve la data di ritiro della v1.1. Ti consigliamo di avviare la migrazione dalla versione 1.1 alla v2 il prima possibile.

Esegui la migrazione della tua applicazione

La migrazione dalla v1.1 alla v2 richiede l'aggiornamento degli URL degli endpoint in modo che effettuino la chiamata alla v2 e l'aggiornamento dell'applicazione per tenere conto delle modifiche che provocano un errore.

Aggiorna le chiamate API dalla versione 1.1 alla versione 2

Per usare la versione 2 anziché la v1.1, devi aggiornare le richieste in modo da usare nuovi endpoint v2.

Individuare i metodi equivalenti

Per aggiornare le chiamate API dalla v1.1 alla v2, devi prima identificare i metodi v1.1 equivalenti in v2.

I seguenti nomi di tutti i servizi e i metodi sono leggermente cambiati tra le versioni 1.1 e 2:

I servizi Queries e Reports nella versione 1.1 sono noti come queries e queries.reports nella versione 2.

Nella versione 2 i metodi sono stati rinominati come segue:

Nome metodo v1.1	Metodo 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`

Aggiorna a nuovi endpoint

Una volta identificati i metodi equivalenti, devi aggiornare le richieste. Ad esempio, per chiamare il metodo queries.getquery con v1.1, devi utilizzare il seguente URL:

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

Per chiamare il metodo equivalente nella v2, noto come queries.get, aggiorna l'URL come segue:

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

Se usi una libreria client per effettuare richieste all'API, utilizza la versione più recente della libreria client e aggiorna la configurazione in modo da utilizzare la versione v2.

Apporta le modifiche desiderate

Stiamo introducendo una serie di modifiche che provocano errori nella versione 2. Consulta le seguenti istruzioni e apporta le modifiche necessarie relative al tuo utilizzo esistente dell'API Bid Manager.

Aggiorna le chiamate al servizio `queries`

I seguenti campi nella risorsa Query, originariamente rappresentati da oggetti nidificati generali, sono stati modificati in modo da utilizzare i seguenti tipi di oggetti:

Campo v1.1	Tipo di oggetto 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`

I seguenti campi nella risorsa Query originariamente rappresentati dagli oggetti dell'elenco generale sono stati modificati in elenchi dei seguenti nuovi tipi di oggetti:

campo elenco v1.1	tipo di oggetto 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`

I seguenti campi nella risorsa Query, originariamente rappresentati da stringhe, sono rappresentati da tipi di enum nella v2 e includono le seguenti modifiche:

L'equivalente v2 di metadata.dataRange ora utilizza l'enum Range. Durante la conversione in questa enumerazione, il valore PREVIOUS_HALF_MONTH è stato rimosso e il valore TYPE_NOT_SUPPORTED è stato modificato in RANGE_UNSPECIFIED.
metadata.format ora utilizza l'enumerazione Format. Durante la conversione in questa enumerazione, il valore EXCEL_CSV è stato rimosso e il valore FORMAT_UNSPECIFIED è stato aggiunto.
params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match e params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match ora usa l'enumerazione Match.
params.options.pathQueryOptions.pathFilters[].pathMatchPosition ora utilizza l'enumerazione PathMatchPosition. Durante la conversione a questa enumerazione, è stato aggiunto il valore PATH_MATCH_POSITION_UNSPECIFIED.
schedule.frequency ora utilizza l'enumerazione Frequency. Eseguendo la conversione in questa enumerazione, è stato aggiunto il valore FREQUENCY_UNSPECIFIED.
params.type ora utilizza l'enumerazione ReportType. La conversione a questa enumerazione prevede le seguenti modifiche:
I seguenti valori sono stati ritirati:
- 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

I restanti valori sono stati tutti aggiornati in modo da riflettere meglio i valori equivalenti nell'interfaccia utente:

Valori v1.1	Valore `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`

I campi metadata.dataRange, reportDataStartTimeMs e reportDataEndTimeMs sono stati sostituiti con i campi range, customStartDate e customEndDate. I nuovi campi data utilizzano oggetti Date invece dei millisecondi dall'epoca di Unix. Questi campi sostitutivi sono stati spostati nell'oggetto DataRange assegnato al campo dataRange nell'oggetto QueryMetadata.
I campi schedule.startTimeMs e schedule.endTimeMs sono stati sostituiti con i campi startDate e endDate nell'oggetto QuerySchedule. I nuovi campi data utilizzano oggetti Date invece dei millisecondi dall'epoca di Unix.
I campi metadata.running, metadata.reportCount, metadata.googleCloudStoragePathForLatestReport, metadata.googleDrivePathForLatestReport e metadata.latestReportRunTimeMs sono stati rimossi. Le informazioni relative ai report generati più di recente per una query devono essere recuperate utilizzando il metodo queries.reports.list con il parametro di query orderBy "key.reportId desc" per garantire che nella richiesta siano elencati per primi i report più recenti.
I campi kind, timezoneCode, metadata.locale, params.includeInviteData e schedule.nextRunMinuteOfDay sono stati rimossi.
queries.create non esegue più automaticamente query dopo la creazione e il parametro di query asynchronous è stato rimosso. Chiama queries.run dopo il giorno queries.create per generare report per le nuove query.
Il metodo queries.run è stato aggiornato nei seguenti modi:
- Il parametro di query asynchronous è stato sostituito con il parametro di query synchronous. Il nuovo parametro di query opera con la logica inversa ed è considerato falso se non specificato. Per questo motivo, per impostazione predefinita queries.run genera i report in modo asincrono nella versione 2, anziché in modo sincrono, che è l'impostazione predefinita nella v1.1.
- Il corpo della richiesta è stato aggiornato per rimuovere il campo timezoneCode e sostituire i campi dataRange, reportDataStartTimeMs, reportDataEndTimeMs e un oggetto DataRange assegnato al campo dataRange.
- Il metodo restituisce l'oggetto Report risultante anziché un corpo della risposta vuoto.
Il campo kind nel corpo della risposta queries.list è stato rimosso.

Aggiorna le chiamate al servizio `reports`

I seguenti campi nella risorsa Report originariamente rappresentati da oggetti nidificati generali sono stati modificati in modo da utilizzare i seguenti tipi di oggetti:

Campo v1.1	Tipo di oggetto 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`

I seguenti campi nella risorsa Report originariamente rappresentati da oggetti elenco generale sono stati modificati in elenchi dei seguenti nuovi tipi di oggetti:

campo elenco v1.1	tipo di oggetto 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`

I seguenti campi nella risorsa Report, originariamente rappresentati da stringhe, sono cambiati, pertanto i campi equivalenti in v2 sono rappresentati da nuovi tipi di enum e includono le modifiche ai valori accettabili:
- metadata.status.format ora utilizza l'enumerazione Format. In conversione in questa enumerazione, il valore EXCEL_CSV è stato rimosso e FORMAT_UNSPECIFIED è stato aggiunto.
- metadata.status.state ora utilizza l'enumerazione State. Nella conversione in questa enumerazione, sono stati aggiunti i valori QUEUED e STATE_UNSPECIFIED.
- params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match e params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match ora usa l'enumerazione Match.
- params.options.pathQueryOptions.pathFilters[].pathMatchPosition ora utilizza l'enumerazione PathMatchPosition. Durante la conversione a questa enumerazione, è stato aggiunto il valore PATH_MATCH_POSITION_UNSPECIFIED.
- params.type ora utilizza l'enumerazione ReportType. Durante la conversione in questa enumerazione, sono state apportate numerose modifiche che sono elencate in dettaglio nella sezione precedente relativa all'aggiornamento delle chiamate di servizio per le query.
I campi metadata.reportDataStartTimeMs e metadata.reportDataEndTimeMs sono stati sostituiti con i campi reportDataStartDate e reportDataEndDate nell'oggetto ReportMetadata. I nuovi campi utilizzano oggetti Date invece dei millisecondi dall'epoca di Unix.
metadata.status.finishTimeMs è stato sostituito dal campo finishTime nell'oggetto ReportStatus. Questo nuovo campo temporale rappresenta la data/ora sotto forma di timestamp in formato RFC3339 UTC "Zulu" anziché in millisecondi dall'epoca di Unix.
I campi metadata.status.failure e params.includeInviteData sono stati rimossi.
Il campo kind nel corpo della risposta reports.list è stato rimosso.

Aggiorna logica di gestione degli errori

I messaggi di errore dell'API sono stati aggiornati nella versione 2. Questi nuovi messaggi di errore sono più specifici e, in alcuni casi, forniscono informazioni sui valori della richiesta API che causano la restituzione dell'errore. Se la logica di gestione degli errori esistente si basa su un testo specifico di messaggi di errore, generalizza la gestione degli errori prima di eseguire la migrazione alla v2.