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
DeviceType
DEVICE_TYPE_TABLET
, anziché con l'ID opzione di targeting del serviziotargetingTypes.targetingOptions
. Le versioni di stringa di questi enum sono rappresentate nel nuovo campoassignedTargetingOptionIdAlias
di queste risorseAssignedTargetingOption
e possono essere utilizzate per recuperare o eliminare il targeting esistente. Il valoreassignedTargetingOptionId
di queste risorseAssignedTargetingOption
non è cambiato.Aggiorna le chiamate che gestiscono i seguenti tipi di targeting in modo da utilizzare i valori dell'enum:
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 metodoadvertisers.lineItems.bulkEditAssignedTargetingOptions
.Il metodo
advertisers.lineItems.bulkListLineItemAssignedTargetingOptions
è stato sostituito dal metodoadvertisers.lineItems.bulkListAssignedTargetingOptions
.Aggiorna le chiamate che gestiscono
TARGETING_TYPE_PROXIMITY_LOCATION_LIST
per 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.bulkEditAdvertiserAssignedTargetingOptions
aadvertisers.editAssignedTargetingOptions
advertisers.bulkListAdvertiserAssignedTargetingOptions
aadvertisers.listAssignedTargetingOptions
advertisers.campaigns.bulkListCampaignAssignedTargetingOptions
aadvertisers.campaigns.listAssignedTargetingOptions
- Da
advertisers.insertionOrders.bulkListInsertionOrderAssignedTargetingOptions
aadvertisers.insertionOrders.listAssignedTargetingOptions
- Da
partners.bulkEditPartnerAssignedTargetingOptions
apartners.editAssignedTargetingOptions
Aggiorna le chiamate al servizio advertisers.lineItems
- Il campo
inventorySourceIds
è stato rimosso. Gestisci l'assegnazione dell'origine dell'inventario utilizzando le risorseAssignedTargetingOption
diTARGETING_TYPE_INVENTORY_SOURCE
. I seguenti valori enumerati
LineItemWarningMessage
sono stati ritirati nella versione 2 e non verranno più visualizzati nella versioneLineItem.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'oggettoLineItemFlight
e 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_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 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.bulkUpdate
per impostare gli stessi valori di campo per più elementi pubblicitari. Al momento sono supportati solo gli aggiornamenti al campoentityStatus
. - Puoi utilizzare
advertisers.lineItems.bulkEditAssignedTargetingOptions
per aggiungere o rimuovere le stesse opzioni di targeting assegnate in 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 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_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