REST Resource: customBiddingAlgorithms.scripts

Recurso: CustomLancesScript

Um único script de lances personalizados.

Representação JSON 
{
  "name": string,
  "customBiddingAlgorithmId": string,
  "customBiddingScriptId": string,
  "createTime": string,
  "active": boolean,
  "state": enum (State),
  "errors": [
    {
      object (ScriptError)
    }
  ],
  "script": {
    object (CustomBiddingScriptRef)
  }
}
Campos
name

string

Apenas saída. O nome do recurso do script de lances personalizados.
customBiddingAlgorithmId

string (int64 format)

Apenas saída. O ID exclusivo do algoritmo de lances personalizados a que o script pertence.
customBiddingScriptId

string (int64 format)

Apenas saída. O ID exclusivo do script de lances personalizados.
createTime

string (Timestamp format)

Apenas saída. A hora em que o script foi criado.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
active

boolean

Apenas saída. Se o script está sendo usado atualmente para pontuação pelo algoritmo pai.
state

enum (State)

Apenas saída. O estado do script de lances personalizados.
errors[]

object (ScriptError)

Apenas saída. Detalhes do erro de um script de lances personalizados rejeitado. Este campo só será preenchido quando [Script.state][] for REJECTED.
script

object (CustomBiddingScriptRef)

A referência ao arquivo de script enviado.

Estado

Estados possíveis de um script de lances personalizados.

Enums
STATE_UNSPECIFIED O estado do script não foi especificado ou é desconhecido nesta versão.
ACCEPTED O script foi aceito para pontuar impressões.
REJECTED O script foi rejeitado por pipelines de back-end. Podem conter erros.
PENDING O script está sendo processado para pipelines de back-end.

ScriptError

Uma mensagem de erro para um script de lances personalizados.

Representação JSON 
{
  "errorCode": enum (ErrorCode),
  "line": string,
  "column": string,
  "errorMessage": string
}
Campos
errorCode

enum (ErrorCode)

O tipo de erro.
line

string (int64 format)

O número da linha no script em que o erro foi gerado.
column

string (int64 format)

O número da coluna no script em que o erro foi gerado.
errorMessage

string

A mensagem de erro detalhada.

ErrorCode

Possíveis códigos de erro de um script de lances personalizados.

Enums
ERROR_CODE_UNSPECIFIED O erro de script não foi especificado ou é desconhecido nesta versão.
SYNTAX_ERROR Há um erro de sintaxe no script.
DEPRECATED_SYNTAX O script usa uma sintaxe descontinuada.
INTERNAL_ERROR Erros internos foram gerados ao processar o script.

CustomBiddingScriptRef

A referência ao arquivo de script de lances personalizados enviado.

Representação JSON 
{
  "resourceName": string
}
Campos
resourceName

string

Um nome de recurso a ser usado em media.download para fazer o download dos arquivos de script. Ou media.upload para fazer upload dos arquivos de script. Os nomes de recursos têm o formato customBiddingAlgorithms/{customBiddingAlgorithmId}/scriptRef/{ref_id}.

Métodos

create

 Cria um novo script de lances personalizados.

get

 Recebe um script de lances personalizados.

list

 Lista os scripts de lances personalizados que pertencem ao algoritmo especificado.