Ultimo aggiornamento: 06/12/2022
Esegui la migrazione dell'applicazione
La migrazione dalla versione 1 alla versione 2 richiede l'aggiornamento degli URL degli endpoint per chiamare la versione 2 e l'aggiornamento dell'applicazione in modo da tenere conto delle modifiche che comportano interruzioni.
Aggiornare le chiamate API dalla versione 1 alla versione 2
Per utilizzare la versione 2 anziché la versione 1, devi aggiornare le richieste in modo che utilizzino i nuovi endpoint v2.
Ad esempio, per chiamare il metodo advertisers.get con la versione 1, devi usare 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 utilizzi una libreria client per effettuare richieste all'API, utilizza la versione 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 comportano interruzioni nella versione 2. Esamina le seguenti istruzioni e apporta le modifiche necessarie in base al tuo utilizzo esistente dell'API Display & Video 360.
Aggiorna le chiamate ai metodi di targeting
Alcuni tipi di targeting ora vengono assegnati utilizzando i valori enum anziché gli ID opzioni di targeting. Ad esempio, i dispositivi tablet ora sono scelti come target direttamente con l'enum
DeviceTypeDEVICE_TYPE_TABLET, anziché con l'ID opzione di targeting del serviziotargetingTypes.targetingOptions. Le versioni di stringa di questi enum sono rappresentate nel nuovo campoassignedTargetingOptionIdAliasdi queste risorseAssignedTargetingOptione possono essere utilizzate per recuperare o eliminare il targeting esistente. Il valoreassignedTargetingOptionIddi queste risorseAssignedTargetingOptionnon è cambiato.Aggiorna le chiamate che gestiscono i seguenti tipi di targeting in modo da utilizzare i valori dell'enum:
TARGETING_TYPE_AGE_RANGETARGETING_TYPE_CONTENT_INSTREAM_POSITIONTARGETING_TYPE_CONTENT_OUTSTREAM_POSITIONTARGETING_TYPE_DEVICE_TYPETARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSIONTARGETING_TYPE_ENVIRONMENTTARGETING_TYPE_EXCHANGETARGETING_TYPE_GENDERTARGETING_TYPE_HOUSEHOLD_INCOMETARGETING_TYPE_NATIVE_CONTENT_POSITIONTARGETING_TYPE_OMIDTARGETING_TYPE_PARENTAL_STATUSTARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSIONTARGETING_TYPE_VIDEO_PLAYER_SIZETARGETING_TYPE_VIEWABILITY
Il metodo
advertisers.lineItems.bulkEditLineItemAssignedTargetingOptionsè stato sostituito dal metodoadvertisers.lineItems.bulkEditAssignedTargetingOptions.Il metodo
advertisers.lineItems.bulkListLineItemAssignedTargetingOptionsè stato sostituito dal metodoadvertisers.lineItems.bulkListAssignedTargetingOptions.Aggiorna le chiamate che gestiscono
TARGETING_TYPE_PROXIMITY_LOCATION_LISTper utilizzare un valore impostato per radius size e distance unit anziché un valore enumeratoProximityRadiusRange.I metodi di targeting che recuperano o modificano le opzioni di targeting in più tipi di targeting in un'unica risorsa principale sono stati rinominati.
Aggiorna le chiamate ai seguenti metodi per utilizzare i nuovi nomi:
advertisers.bulkEditAdvertiserAssignedTargetingOptionsaadvertisers.editAssignedTargetingOptionsadvertisers.bulkListAdvertiserAssignedTargetingOptionsaadvertisers.listAssignedTargetingOptionsadvertisers.campaigns.bulkListCampaignAssignedTargetingOptionsaadvertisers.campaigns.listAssignedTargetingOptions- Da
advertisers.insertionOrders.bulkListInsertionOrderAssignedTargetingOptionsaadvertisers.insertionOrders.listAssignedTargetingOptions - Da
partners.bulkEditPartnerAssignedTargetingOptionsapartners.editAssignedTargetingOptions
Aggiorna le chiamate al servizio advertisers.lineItems
- Il campo
inventorySourceIdsè stato rimosso. Gestisci l'assegnazione dell'origine dell'inventario utilizzando le risorseAssignedTargetingOptiondiTARGETING_TYPE_INVENTORY_SOURCE. I seguenti valori enumerati
LineItemWarningMessagesono stati ritirati nella versione 2 e non verranno più visualizzati nella versioneLineItem.warningMessages:NO_POSITIVE_AUDIENCE_LIST_TARGETEDAPP_INSTALL_NO_CONVERSION_PIXELTARGETING_REVOKED_OR_CLOSED_USER_LISTAPP_INSTALL_NO_OPTIMAL_BIDDING_STRATEGYCREATIVE_SIZE_NOT_IN_USE_FOR_TARGETED_DEALSNO_CREATIVE_FOR_TARGETED_DEALSTARGETING_DEPRECATED_GEO_TARGET
Il campo
triggerIdè stato rimosso dall'oggettoLineItemFlighte il valoreLINE_ITEM_FLIGHT_DATE_TYPE_TRIGGERè stato rimosso dal tipo di enumerazioneLineItemFlightDateType. La versione 2 non supporta l'impostazione della spesa per gli elementi pubblicitari in base all'attivazione degli attivatori manuali.
Aggiorna le chiamate al servizio customBiddingAlgorithms
I campi customBiddingAlgorithmState e modelReadiness
sono stati sostituiti dal campo modelDetails
, che fornisce gli stati di idoneità
e sospensione del modello di algoritmo esistente
per ogni inserzionista che ha accesso tramite un elenco di
oggetti CustomBiddingModelDetails.
Ulteriori modifiche
Oltre alle modifiche incompatibili 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 di YouTube
Nella versione 2, gli elementi pubblicitari di YouTube e le relative impostazioni di targeting possono essere recuperati utilizzando rispettivamente i servizi advertisers.lineItems e advertisers.lineItems.targetingTypes.assignedTargetingOptions. L'API fornisce l'accesso di sola lettura, il che significa che qualsiasi tentativo di richiesta di scrittura a questi elementi pubblicitari restituirà un errore. Gli elementi pubblicitari di YouTube possono avere uno dei seguenti valori LineItemType:
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_ACTIONLINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_AUDIOLINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLELINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE_OVER_THE_TOPLINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACHLINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH_OVER_THE_TOPLINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLELINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE_OVER_THE_TOPLINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE
Nuovi metodi che consentono un rendimento migliore
Nella versione 2, il servizio advertisers.lineItems fornisce nuovi metodi da utilizzare al posto delle richieste collettive per migliorare le prestazioni e ridurre il consumo di quota:
- Puoi utilizzare
advertisers.lineItems.bulkUpdateper impostare gli stessi valori di campo per più elementi pubblicitari. Al momento sono supportati solo gli aggiornamenti al campoentityStatus. - Puoi utilizzare
advertisers.lineItems.bulkEditAssignedTargetingOptionsper aggiungere o rimuovere le stesse opzioni di targeting assegnate in più elementi pubblicitari. - Puoi utilizzare
advertisers.lineItems.bulkListAssignedTargetingOptionsper elencare le opzioni di targeting assegnate in più elementi pubblicitari. - Puoi utilizzare
advertisers.lineItems.duplicateper 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 degli ordini di inserzione
Nella versione 2, puoi modificare un sottoinsieme di impostazioni di targeting per le risorse InsertionOrder utilizzando i nuovi metodi create e
delete nel servizio
advertisers.insertionOrders.targetingTypes.assignedTargetingOptions. I seguenti tipi di targeting possono essere gestiti completamente a livello di ordine di inserzione:
TARGETING_TYPE_AGE_RANGETARGETING_TYPE_BROWSERTARGETING_TYPE_CATEGORYTARGETING_TYPE_CHANNELTARGETING_TYPE_DEVICE_MAKE_MODELTARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSIONTARGETING_TYPE_ENVIRONMENTTARGETING_TYPE_GENDERTARGETING_TYPE_KEYWORDTARGETING_TYPE_LANGUAGETARGETING_TYPE_NEGATIVE_KEYWORD_LISTTARGETING_TYPE_OPERATING_SYSTEMTARGETING_TYPE_PARENTAL_STATUSTARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSIONTARGETING_TYPE_VIEWABILITY