Resource: CustomBiddingScript
A single custom bidding script.
JSON representation |
---|
{ "name": string, "customBiddingAlgorithmId": string, "customBiddingScriptId": string, "createTime": string, "active": boolean, "state": enum ( |
Fields | |
---|---|
name |
Output only. The resource name of the custom bidding script. |
custom |
Output only. The unique ID of the custom bidding algorithm the script belongs to. |
custom |
Output only. The unique ID of the custom bidding script. |
create |
Output only. The time when the script was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
active |
Output only. Whether the script is currently being used for scoring by the parent algorithm. |
state |
Output only. The state of the custom bidding script. |
errors[] |
Output only. Error details of a rejected custom bidding script. This field will only be populated when |
script |
The reference to the uploaded script file. |
State
Possible states of a custom bidding script.
Enums | |
---|---|
STATE_UNSPECIFIED |
The script state is not specified or is unknown in this version. |
ACCEPTED |
The script has been accepted for scoring impressions. |
REJECTED |
The script has been rejected by backend pipelines. It may have errors. |
PENDING |
The script is being processed for backend pipelines. |
ScriptError
An error message for a custom bidding script.
JSON representation |
---|
{
"errorCode": enum ( |
Fields | |
---|---|
error |
The type of error. |
line |
The line number in the script where the error was thrown. |
column |
The column number in the script where the error was thrown. |
error |
The detailed error message. |
ErrorCode
Possible error codes of a custom bidding script error.
Enums | |
---|---|
ERROR_CODE_UNSPECIFIED |
The script error is not specified or is unknown in this version. |
SYNTAX_ERROR |
The script has a syntax error. |
DEPRECATED_SYNTAX |
The script uses deprecated syntax. |
INTERNAL_ERROR |
Internal errors were thrown while processing the script. |
CustomBiddingScriptRef
The reference to the uploaded custom bidding script file.
JSON representation |
---|
{ "resourceName": string } |
Fields | |
---|---|
resource |
A resource name to be used in |
Methods |
|
---|---|
|
Creates a new custom bidding script. |
|
Gets a custom bidding script. |
|
Lists custom bidding scripts that belong to the given algorithm. |