A marzo 2022 abbiamo rilasciato la versione 2 dell'API Bid Manager. Dato il di questa nuova versione, prevediamo di annunciare a breve una data di ritiro per la v1.1. Me ti consigliamo di avviare la migrazione dalla versione 1.1 alla versione 2 appena possibile.
Esegui la migrazione dell'applicazione
La migrazione dalla versione v1.1 alla v2 richiede l'aggiornamento degli URL dell'endpoint per chiamare la versione v2 e aggiornare l'applicazione per tenere conto delle modifiche che provocano un errore.
Aggiorna le chiamate API dalla versione 1.1 alla v2
Per utilizzare la versione v2 anziché la versione 1.1, devi aggiornare le richieste in modo da utilizzare la nuova versione v2 endpoint.
Individuare i metodi equivalenti
Per aggiornare le chiamate API dalla versione 1.1 alla versione 2, devi prima identificare gli equivalenti metodi v1.1 nella v2.
I seguenti nomi di tutti i servizi e metodi sono leggermente cambiati tra v1.1 e v2:
- I servizi
Queries
eReports
nella versione 1.1 sono noti comequeries
equeries.reports
nella versione 2. - I metodi sono stati rinominati come segue nella versione 2:
Nome del 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 metodi equivalenti, devi aggiornare le richieste. Per
ad esempio, per chiamare il metodo queries.getquery
con la versione 1.1, devi utilizzare
al seguente URL:
https://www.googleapis.com/doubleclickbidmanager/v1.1/query/queryId
Per chiamare il metodo equivalente nella versione 2, noto come queries.get
, aggiorna il valore
URL al seguente indirizzo:
GET https://doubleclickbidmanager.googleapis.com/v2/queries/queryId
Se utilizzi una libreria client per effettuare richieste all'API, utilizza la più recente della libreria client e aggiorna la configurazione per utilizzare la versione 2.
Apporta le modifiche desiderate
Stiamo introducendo una serie di modifiche che provocano un errore nella versione 2. Esamina quanto segue istruzioni e apportare le modifiche necessarie pertinenti all'utilizzo esistente dei l'API Bid Manager.
Aggiorna le chiamate al servizio queries
- I seguenti campi nella risorsa
Query
rappresentati originariamente dal ruolo generale gli oggetti nidificati sono cambiati in modo da utilizzare i seguenti tipi di oggetti: - I seguenti campi nella risorsa
Query
rappresentati originariamente dal ruolo generale gli oggetti list sono cambiati in elenchi dei seguenti nuovi tipi di oggetti: - I seguenti campi nella risorsa
Query
, rappresentati originariamente da sono rappresentate da tipi di enum nella versione 2 e includono quanto segue: modifiche:- L'equivalente v2 di
metadata.dataRange
ora utilizzaRange
enum. Durante la conversione in questa enum, il valorePREVIOUS_HALF_MONTH
è stato rimosso e il valoreTYPE_NOT_SUPPORTED
è stato modificato inRANGE_UNSPECIFIED
. metadata.format
ora utilizza l'enumerazioneFormat
. Durante la conversione a questa enum, il valoreEXCEL_CSV
è stato rimosso e il valoreFORMAT_UNSPECIFIED
aggiunto.params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match
eparams.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match
ora utilizza l'enumerazioneMatch
.params.options.pathQueryOptions.pathFilters[].pathMatchPosition
ora utilizza l'enumerazionePathMatchPosition
. Con la conversione in questa enum, è stato aggiunto il valorePATH_MATCH_POSITION_UNSPECIFIED
.schedule.frequency
ora utilizza l'enumerazioneFrequency
. Nella convertendo in questa enum, è stato aggiunto il valoreFREQUENCY_UNSPECIFIED
.params.type
ora utilizza l'enumerazioneReportType
. Nella a questa enum, sono state apportate 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
- Tutti i valori rimanenti sono stati aggiornati per rispecchiare meglio i loro
valori equivalenti nell'interfaccia utente:
Valori v1.1 Valore ReportType
equivalenteTYPE_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
- L'equivalente v2 di
- Campi
metadata.dataRange
,reportDataStartTimeMs
ereportDataEndTimeMs
sono stati sostituiti da campirange
,customStartDate
ecustomEndDate
. I nuovi campi data utilizzanoDate
anziché in millisecondi dall'epoca di Unix. Questi campi sostitutivi sono stati spostati nell'oggettoDataRange
assegnato all'dataRange
nelQueryMetadata
. - Campi
schedule.startTimeMs
eschedule.endTimeMs
sono stati sostituiti con campistartDate
eendDate
in l'oggettoQuerySchedule
. I nuovi campi data utilizzanoDate
anziché in millisecondi dall'epoca di Unix. - Campi
metadata.running
,metadata.reportCount
,metadata.googleCloudStoragePathForLatestReport
,metadata.googleDrivePathForLatestReport
emetadata.latestReportRunTimeMs
sono state rimosse. Le informazioni relative agli ultimi report generati per una query devono può essere recuperata utilizzando il metodoqueries.reports.list
conorderBy
parametro di query di "key.reportId desc" a garantisce che nella richiesta vengano elencati per primi i report più recenti. - Campi
kind
,timezoneCode
,metadata.locale
,params.includeInviteData
eschedule.nextRunMinuteOfDay
sono state rimosse. queries.create
non esegue più automaticamente le query dopo la creazione e il parametro di queryasynchronous
è stato rimosso. Chiamaqueries.run
dopoqueries.create
per generare report per nuove query.- Il metodo
queries.run
è stato aggiornato nei seguenti modi:- Il parametro di query
asynchronous
è stato sostituito con Parametro di querysynchronous
. Il nuovo parametro di query opera con la logica inversa ed è considerato falso se non specificato. Dato Questo,queries.run
genera report in modo asincrono per impostazione predefinita rispetto alla versione sincrona, che è l'impostazione predefinita nella versione v1.1. - Il corpo della richiesta è stato aggiornato in modo da rimuovere
timezoneCode
e sostituiscidataRange
,reportDataStartTimeMs
,reportDataEndTimeMs
campi con unDataRange
assegnato all'oggettodataRange
. - Il metodo restituisce l'oggetto
Report
risultante anziché un corpo della risposta vuoto.
- Il parametro di query
- Il campo
kind
nel corpo della risposta diqueries.list
è stato rimosso.
Aggiorna le chiamate al servizio reports
- I seguenti campi nella risorsa
Report
rappresentati originariamente da gli oggetti nidificati generali sono cambiati per utilizzare i seguenti tipi di oggetti: - I seguenti campi nella risorsa
Report
rappresentati originariamente da Gli oggetti elenco generali sono cambiati in elenchi del nuovo oggetto seguente tipi: - I seguenti campi nella risorsa
Report
rappresentati originariamente da di stringhe sono state modificate quindi i campi equivalenti nella versione 2 sono rappresentati da enum e includono le modifiche ai valori accettati:metadata.status.format
ora utilizza l'enumerazioneFormat
. Nella a questa enum, il valoreEXCEL_CSV
è stato rimossoFORMAT_UNSPECIFIED
aggiunto.metadata.status.state
ora utilizza l'enumerazioneState
. Nella che converte in questa enum, i valoriQUEUED
eSTATE_UNSPECIFIED
hanno è stato aggiunto.params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match
eparams.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match
ora utilizza l'enumerazioneMatch
.params.options.pathQueryOptions.pathFilters[].pathMatchPosition
ora utilizza l'enumerazionePathMatchPosition
. Con la conversione in questa enum, è stato aggiunto il valorePATH_MATCH_POSITION_UNSPECIFIED
.params.type
ora utilizza l'enumerazioneReportType
. Nella a questa enum, sono state apportate numerose modifiche che sono elencate nella sezione precedente relativa all'aggiornamento delle chiamate di servizio delle query.
- Campi
metadata.reportDataStartTimeMs
emetadata.reportDataEndTimeMs
sono stati sostituiti conreportDataStartDate
e i campireportDataEndDate
inReportMetadata
. I nuovi campi utilizzanoDate
invece dei millisecondi dall'epoca di Unix. metadata.status.finishTimeMs
è stato sostituito da il campofinishTime
nellaReportStatus
. Questo nuovo campo temporale rappresenta data/ora come timestamp nel formato RFC3339 UTC "Zulu" anziché in millisecondi dall'epoca di Unix.metadata.status.failure
e I campiparams.includeInviteData
sono stati rimossi.- Il campo
kind
nel corpo della risposta direports.list
contiene rimosso.
Aggiorna la 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 Richiesta API che determina la restituzione dell'errore. Se l'errore esistente la logica di gestione si basa su un testo specifico del messaggio di errore, generalizza l'errore prima di eseguire la migrazione alla versione v2.