Esegui la migrazione dalla versione v1 alla versione 2

Ultimo aggiornamento: 06-12-2022

Esegui la migrazione della tua applicazione

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

Aggiorna le chiamate API da v1 a v2

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

Ad esempio, per chiamare il metodo advertisers.get con v1, devi utilizzare il seguente URL:

GET https://displayvideo.googleapis.com/v1/advertisers/advertiserId

Per la versione 2, aggiorna l'URL come segue:

GET https://displayvideo.googleapis.com/v2/advertisers/advertiserId

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 all'utilizzo esistente dell'API Display & Video 360.

Aggiorna le chiamate ai metodi di targeting

• Alcuni tipi di targeting vengono ora assegnati utilizzando valori di enumerazione anziché ID opzione di targeting. Ad esempio, i dispositivi tablet ora vengono scelti come target direttamente con l'enum DEVICE_TYPE_TABLET DeviceType, anziché con l'ID opzione di targeting del servizio targetingTypes.targetingOptions. Le versioni stringa di queste enumerazioni sono rappresentate nel nuovo campo assignedTargetingOptionIdAlias in queste risorse AssignedTargetingOption e possono essere utilizzate quando si recupera o elimina il targeting esistente. Il valore assignedTargetingOptionId di queste risorse AssignedTargetingOption non è cambiato.

  Aggiorna le chiamate che gestiscono i seguenti tipi di targeting in modo che utilizzino i valori di enumerazione:

  • TARGETING_TYPE_AGE_RANGE
  • TARGETING_TYPE_CONTENT_INSTREAM_POSITION
  • TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
  • TARGETING_TYPE_DEVICE_TYPE
  • TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
  • TARGETING_TYPE_ENVIRONMENT
  • TARGETING_TYPE_EXCHANGE
  • TARGETING_TYPE_GENDER
  • TARGETING_TYPE_HOUSEHOLD_INCOME
  • TARGETING_TYPE_NATIVE_CONTENT_POSITION
  • TARGETING_TYPE_OMID
  • TARGETING_TYPE_PARENTAL_STATUS
  • TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
  • TARGETING_TYPE_VIDEO_PLAYER_SIZE
  • TARGETING_TYPE_VIEWABILITY

• Il metodo advertisers.lineItems.bulkEditLineItemAssignedTargetingOptions è stato sostituito dal metodo advertisers.lineItems.bulkEditAssignedTargetingOptions.

• Il metodo advertisers.lineItems.bulkListLineItemAssignedTargetingOptions è stato sostituito dal metodo advertisers.lineItems.bulkListAssignedTargetingOptions.

• Aggiorna le chiamate che gestiscono TARGETING_TYPE_PROXIMITY_LOCATION_LIST in modo da utilizzare una dimensione del raggio e un'unità di distanza impostati anziché un valore enumerato ProximityRadiusRange.

• I metodi di targeting che recuperano o modificano le opzioni di targeting in più tipi di targeting all'interno di un'unica risorsa padre sono stati rinominati.

  Aggiorna le chiamate ai seguenti metodi per utilizzare i nuovi nomi:

  • Da advertisers.bulkEditAdvertiserAssignedTargetingOptions a advertisers.editAssignedTargetingOptions
  • Da advertisers.bulkListAdvertiserAssignedTargetingOptions a advertisers.listAssignedTargetingOptions
  • Da advertisers.campaigns.bulkListCampaignAssignedTargetingOptions a advertisers.campaigns.listAssignedTargetingOptions
  • Da advertisers.insertionOrders.bulkListInsertionOrderAssignedTargetingOptions a advertisers.insertionOrders.listAssignedTargetingOptions
  • Da partners.bulkEditPartnerAssignedTargetingOptions a partners.editAssignedTargetingOptions

Aggiorna le chiamate al servizio advertisers.lineItems

• Il campo inventorySourceIds è stato rimosso. Gestisci l'assegnazione dell'origine dell'inventario utilizzando le risorse AssignedTargetingOption di TARGETING_TYPE_INVENTORY_SOURCE.

• I seguenti valori enum di LineItemWarningMessage sono stati deprecati nella versione 2 e non verranno più visualizzati in LineItem.warningMessages:

  • NO_POSITIVE_AUDIENCE_LIST_TARGETED
  • APP_INSTALL_NO_CONVERSION_PIXEL
  • TARGETING_REVOKED_OR_CLOSED_USER_LIST
  • APP_INSTALL_NO_OPTIMAL_BIDDING_STRATEGY
  • CREATIVE_SIZE_NOT_IN_USE_FOR_TARGETED_DEALS
  • NO_CREATIVE_FOR_TARGETED_DEALS
  • TARGETING_DEPRECATED_GEO_TARGET

• Il campo triggerId è stato rimosso dall'oggetto LineItemFlight e il valore LINE_ITEM_FLIGHT_DATE_TYPE_TRIGGER è stato rimosso dal tipo di enumerazione LineItemFlightDateType. La versione v2 non supporta l'impostazione della spesa degli elementi pubblicitari in base all'attivazione degli attivatori manuali.

Aggiorna le chiamate al servizio customBiddingAlgorithms

I campi customBiddingAlgorithmState e modelReadiness sono stati sostituiti con il campo modelDetails , che fornisce gli stati di idoneità e sospensione del modello dell'algoritmo esistente per ogni inserzionista che ha accesso tramite un elenco di CustomBiddingModelDetails oggetti.

Ulteriori modifiche

Oltre alle modifiche che provocano un errore elencate sopra, la versione 2 introduce anche nuove funzionalità.

Le funzionalità aggiunte alla versione 2 dopo il lancio iniziale sono disponibili nelle nostre note di rilascio.

Accesso di sola lettura agli elementi pubblicitari YouTube

Nella versione 2, gli elementi pubblicitari YouTube e le relative impostazioni di targeting possono essere recuperati utilizzando rispettivamente i servizi advertisers.lineItems e advertisers.lineItems.targetingTypes.assignedTargetingOptions. L'API fornisce accesso di sola lettura, il che significa che qualsiasi richiesta di scrittura tentata effettuata per questi elementi pubblicitari restituirà un errore. Gli elementi pubblicitari YouTube avranno uno dei seguenti valori LineItemType:

• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_ACTION
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_AUDIO
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE_OVER_THE_TOP
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH_OVER_THE_TOP
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE_OVER_THE_TOP
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE

Nuovi metodi che consentono di migliorare il rendimento

Nella versione 2, il servizio advertisers.lineItems offre nuovi metodi da utilizzare al posto delle richieste in batch per migliorare le prestazioni e ridurre il consumo di quota:

• Puoi utilizzare advertisers.lineItems.bulkUpdate per impostare gli stessi valori di campo per più elementi pubblicitari. Attualmente sono supportati solo gli aggiornamenti del campo entityStatus.
• Puoi utilizzare advertisers.lineItems.bulkEditAssignedTargetingOptions per aggiungere o rimuovere le stesse opzioni di targeting assegnate a più elementi pubblicitari.
• Puoi utilizzare advertisers.lineItems.bulkListAssignedTargetingOptions per elencare le opzioni di targeting assegnate in più elementi pubblicitari.
• Puoi utilizzare advertisers.lineItems.duplicate per creare un duplicato di un elemento pubblicitario esistente all'interno dello stesso ordine di inserzione, copiando tutte le configurazioni e le impostazioni di targeting.

Accesso in scrittura parziale per il targeting dell'ordine di inserzione

Nella versione 2 puoi modificare le impostazioni di targeting di un sottoinsieme per le risorse InsertionOrder utilizzando i nuovi metodi create e delete nel servizio advertisers.insertionOrders.targetingTypes.assignedTargetingOptions. I seguenti tipi di targeting possono essere completamente gestiti a livello di ordine di inserzione:

• TARGETING_TYPE_AGE_RANGE
• TARGETING_TYPE_BROWSER
• TARGETING_TYPE_CATEGORY
• TARGETING_TYPE_CHANNEL
• TARGETING_TYPE_DEVICE_MAKE_MODEL
• TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
• TARGETING_TYPE_ENVIRONMENT
• TARGETING_TYPE_GENDER
• TARGETING_TYPE_KEYWORD
• TARGETING_TYPE_LANGUAGE
• TARGETING_TYPE_NEGATIVE_KEYWORD_LIST
• TARGETING_TYPE_OPERATING_SYSTEM
• TARGETING_TYPE_PARENTAL_STATUS
• TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
• TARGETING_TYPE_VIEWABILITY