CustomBiddingAlgorithm

import type { CustomBiddingAlgorithm } from "https://googleapis.deno.dev/v1/displayvideo:v3.ts";

A single custom bidding algorithm.

interface CustomBiddingAlgorithm {

advertiserId?: bigint;

readonly customBiddingAlgorithmId?: bigint;

customBiddingAlgorithmType?:

| "CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED"

| "SCRIPT_BASED"

| "ADS_DATA_HUB_BASED"

| "GOAL_BUILDER_BASED"

| "RULE_BASED";

displayName?: string;

entityStatus?:

| "ENTITY_STATUS_UNSPECIFIED"

| "ENTITY_STATUS_ACTIVE"

| "ENTITY_STATUS_ARCHIVED"

| "ENTITY_STATUS_DRAFT"

| "ENTITY_STATUS_PAUSED"

| "ENTITY_STATUS_SCHEDULED_FOR_DELETION";

readonly modelDetails?: CustomBiddingModelDetails[];

readonly name?: string;

partnerId?: bigint;

sharedAdvertiserIds?: bigint[];

}

§Properties

advertiserId?: bigint

[src]

Immutable. The unique ID of the advertiser that owns the custom bidding algorithm.

readonly customBiddingAlgorithmId?: bigint

[src]

Output only. The unique ID of the custom bidding algorithm. Assigned by the system.

customBiddingAlgorithmType?: "CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED" | "SCRIPT_BASED" | "ADS_DATA_HUB_BASED" | "GOAL_BUILDER_BASED" | "RULE_BASED"

[src]

Required. Immutable. The type of custom bidding algorithm.

displayName?: string

[src]

Required. The display name of the custom bidding algorithm. Must be UTF-8 encoded with a maximum size of 240 bytes.

[src]

Controls whether or not the custom bidding algorithm can be used as a bidding strategy. Accepted values are: * ENTITY_STATUS_ACTIVE * ENTITY_STATUS_ARCHIVED

readonly modelDetails?: CustomBiddingModelDetails[]

[src]

Output only. The details of custom bidding models for each advertiser who has access. This field may only include the details of the queried advertiser if the algorithm owner is a partner and is being retrieved using an advertiser accessor.

readonly name?: string

[src]

Output only. The resource name of the custom bidding algorithm.

partnerId?: bigint

[src]

Immutable. The unique ID of the partner that owns the custom bidding algorithm.

sharedAdvertiserIds?: bigint[]

[src]

The IDs of the advertisers who have access to this algorithm. If advertiser_id is set, this field will only consist of that value. This field will not be set if the algorithm owner is a partner and is being retrieved using an advertiser accessor.