REST Resource: customBiddingAlgorithms

Risorsa: CustomBiddingAlgorithm

Un singolo algoritmo di offerta personalizzata.

Rappresentazione JSON 
{
  "name": string,
  "customBiddingAlgorithmId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "customBiddingAlgorithmType": enum (CustomBiddingAlgorithmType),
  "sharedAdvertiserIds": [
    string
  ],
  "modelDetails": [
    {
      object (CustomBiddingModelDetails)
    }
  ],

  // Union field owner can be only one of the following:
  "partnerId": string,
  "advertiserId": string
  // End of list of possible types for union field owner.
}
Campi
name

string

Solo output. Il nome risorsa dell'algoritmo di offerta personalizzata.
customBiddingAlgorithmId

string (int64 format)

Solo output. L'ID univoco dell'algoritmo di offerta personalizzata. Assegnato dal sistema.
displayName

string

Obbligatorio. Il nome visualizzato dell'algoritmo di offerta personalizzata.

Deve essere codificata in UTF-8 con una dimensione massima di 240 byte.
entityStatus

enum (EntityStatus)

Controlla se l'algoritmo di offerta personalizzata può essere utilizzato come strategia di offerta.

I valori accettati sono:

  • ENTITY_STATUS_ACTIVE
  • ENTITY_STATUS_ARCHIVED
customBiddingAlgorithmType

enum (CustomBiddingAlgorithmType)

Obbligatorio. Immutabile. Il tipo di algoritmo di offerta personalizzata.
sharedAdvertiserIds[]

string (int64 format)

Gli ID degli inserzionisti che hanno accesso a questo algoritmo. Se advertiserId è impostato, questo campo conterrà solo quel valore.

Questo campo non verrà impostato se l'algoritmo owner è un partner e viene recuperato utilizzando un accessor inserzionista.
modelDetails[]

object (CustomBiddingModelDetails)

Solo output. I dettagli dei modelli di offerta personalizzata per ogni inserzionista che ha accesso.

Questo campo può includere i dettagli dell'inserzionista per cui è stata eseguita la query solo se l'algoritmo owner è un partner e viene recuperato utilizzando un accessor dell'inserzionista.
Campo unione owner. Identifica l'entità DV360 proprietaria dell'algoritmo di offerta personalizzata. Può trattarsi di un partner o di un inserzionista. owner può essere solo uno dei seguenti:
partnerId

string (int64 format)

Immutabile. L'ID univoco del partner proprietario dell'algoritmo di offerta personalizzata.
advertiserId

string (int64 format)

Immutabile. L'ID univoco dell'inserzionista proprietario dell'algoritmo di offerta personalizzata.

CustomBiddingAlgorithmType

Possibili tipi di algoritmi di offerta personalizzata.

Enum
CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED Il tipo di algoritmo non è specificato o è sconosciuto in questa versione.
SCRIPT_BASED Algoritmo generato tramite file di script di offerte personalizzate caricati dal cliente.
ADS_DATA_HUB_BASED

DEPRECATO: ADS_DATA_HUB_BASED è stato ritirato. Algoritmo creato tramite il prodotto Ads Data Hub.
GOAL_BUILDER_BASED

DEPRECATO: GOAL_BUILDER_BASED è stato ritirato, non è più supportato ed è stato sostituito da RULE_BASED. Algoritmo creato tramite il Generatore di obiettivi nell'interfaccia utente di DV3.

Gli algoritmi esistenti di questo tipo sono stati migrati a RULE_BASED.
RULE_BASED

Algoritmo basato su regole definite. Queste regole sono definite nell'API utilizzando l'oggetto AlgorithmRules.

Questo tipo di algoritmo è disponibile solo per i clienti autorizzati. Gli altri clienti che tentano di utilizzare questo tipo riceveranno un errore.

CustomBiddingModelDetails

I dettagli di un modello di algoritmo di offerta personalizzata per un singolo inserzionista condiviso.

Rappresentazione JSON 
{
  "advertiserId": string,
  "readinessState": enum (ReadinessState),
  "suspensionState": enum (SuspensionState)
}
Campi
advertiserId

string (int64 format)

L'ID univoco dell'inserzionista pertinente.
readinessState

enum (ReadinessState)

Lo stato di idoneità del modello di offerte personalizzate.
suspensionState

enum (SuspensionState)

Solo output. Lo stato di sospensione del modello di offerte personalizzate.

ReadinessState

Stati possibili dell'idoneità del modello.

Enum
READINESS_STATE_UNSPECIFIED Lo stato non è specificato o è sconosciuto in questa versione.
READINESS_STATE_ACTIVE Il modello è addestrato e pronto per la pubblicazione.
READINESS_STATE_INSUFFICIENT_DATA I dati non sono sufficienti per addestrare il modello di pubblicazione.
READINESS_STATE_TRAINING Il modello è in fase di addestramento e non è pronto per la distribuzione.
READINESS_STATE_NO_VALID_SCRIPT Non è stato fornito uno script di offerte personalizzate valido per l'addestramento del modello. Questo stato verrà applicato solo agli algoritmi il cui customBiddingAlgorithmType è SCRIPT_BASED.
READINESS_STATE_EVALUATION_FAILURE È stato fornito uno script valido, ma la valutazione non è riuscita. Ciò vale per gli script che non è stato possibile valutare nel tempo assegnato.

SuspensionState

Possibili stati di sospensione dei modelli di offerte personalizzate.

Enum
SUSPENSION_STATE_UNSPECIFIED Lo stato non è specificato o è sconosciuto in questa versione.
SUSPENSION_STATE_ENABLED Il modello è abilitato, utilizzato di recente, in uso o pianificato per l'utilizzo. L'algoritmo sta assegnando attivamente un punteggio alle impressioni per questo inserzionista.
SUSPENSION_STATE_DORMANT Il modello non è stato utilizzato di recente. Anche se il modello funge ancora da ENABLED, alla fine verrà sospeso se non viene utilizzato.
SUSPENSION_STATE_SUSPENDED Il modello è sospeso dall'assegnazione del punteggio delle impressioni e non può essere pubblicato. Se l'algoritmo viene assegnato a un elemento pubblicitario di questo inserzionista o viene aggiornato in altro modo, tornerà allo stato ENABLED e richiederà tempo per preparare nuovamente il modello di pubblicazione.

Metodi

create

 Crea un nuovo algoritmo di offerta personalizzata.

get

 Recupera un algoritmo di offerta personalizzata.

list

 Elenca gli algoritmi di offerta personalizzata accessibili all'utente corrente e utilizzabili nelle strategie di offerta.

patch

 Aggiorna un algoritmo di offerta personalizzata esistente.

uploadRules

 Crea un oggetto di riferimento delle regole per un file AlgorithmRules.

uploadScript

 Crea un oggetto di riferimento per lo script di offerte personalizzate per un file di script.