com.google.api.services.displayvideo.v2.model

Class CustomBiddingAlgorithm

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.displayvideo.v2.model.CustomBiddingAlgorithm

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class CustomBiddingAlgorithm
extends com.google.api.client.json.GenericJson

A single custom bidding algorithm.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Display & Video 360 API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
CustomBiddingAlgorithm()

Method Summary

Modifier and Type	Method and Description
CustomBiddingAlgorithm	clone()
Long	getAdvertiserId() Immutable.
Long	getCustomBiddingAlgorithmId() Output only.
String	getCustomBiddingAlgorithmType() Required.
String	getDisplayName() Required.
String	getEntityStatus() Controls whether or not the custom bidding algorithm can be used as a bidding strategy.
List<CustomBiddingModelDetails>	getModelDetails() Output only.
String	getName() Output only.
Long	getPartnerId() Immutable.
List<Long>	getSharedAdvertiserIds() The IDs of the advertisers who have access to this algorithm.
CustomBiddingAlgorithm	set(String fieldName, Object value)
CustomBiddingAlgorithm	setAdvertiserId(Long advertiserId) Immutable.
CustomBiddingAlgorithm	setCustomBiddingAlgorithmId(Long customBiddingAlgorithmId) Output only.
CustomBiddingAlgorithm	setCustomBiddingAlgorithmType(String customBiddingAlgorithmType) Required.
CustomBiddingAlgorithm	setDisplayName(String displayName) Required.
CustomBiddingAlgorithm	setEntityStatus(String entityStatus) Controls whether or not the custom bidding algorithm can be used as a bidding strategy.
CustomBiddingAlgorithm	setModelDetails(List<CustomBiddingModelDetails> modelDetails) Output only.
CustomBiddingAlgorithm	setName(String name) Output only.
CustomBiddingAlgorithm	setPartnerId(Long partnerId) Immutable.
CustomBiddingAlgorithm	setSharedAdvertiserIds(List<Long> sharedAdvertiserIds) The IDs of the advertisers who have access to this algorithm.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

CustomBiddingAlgorithm

public CustomBiddingAlgorithm()

Method Detail

getAdvertiserId

public Long getAdvertiserId()

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

Returns:

value or null for none

setAdvertiserId

public CustomBiddingAlgorithm setAdvertiserId(Long advertiserId)

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

Parameters:

advertiserId - advertiserId or null for none

getCustomBiddingAlgorithmId

public Long getCustomBiddingAlgorithmId()

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

Returns:

value or null for none

setCustomBiddingAlgorithmId

public CustomBiddingAlgorithm setCustomBiddingAlgorithmId(Long customBiddingAlgorithmId)

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

Parameters:

customBiddingAlgorithmId - customBiddingAlgorithmId or null for none

getCustomBiddingAlgorithmType

public String getCustomBiddingAlgorithmType()

Required. Immutable. The type of custom bidding algorithm.

Returns:

value or null for none

setCustomBiddingAlgorithmType

public CustomBiddingAlgorithm setCustomBiddingAlgorithmType(String customBiddingAlgorithmType)

Required. Immutable. The type of custom bidding algorithm.

Parameters:

customBiddingAlgorithmType - customBiddingAlgorithmType or null for none

getDisplayName

public String getDisplayName()

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

Returns:

value or null for none

setDisplayName

public CustomBiddingAlgorithm setDisplayName(String displayName)

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

Parameters:

displayName - displayName or null for none

getEntityStatus

public String getEntityStatus()

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

Returns:

value or null for none

setEntityStatus

public CustomBiddingAlgorithm setEntityStatus(String entityStatus)

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

Parameters:

entityStatus - entityStatus or null for none

getModelDetails

public List<CustomBiddingModelDetails> getModelDetails()

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`](/display- video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display- video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).

Returns:

value or null for none

setModelDetails

public CustomBiddingAlgorithm setModelDetails(List<CustomBiddingModelDetails> modelDetails)

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`](/display- video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display- video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).

Parameters:

modelDetails - modelDetails or null for none

getName

public String getName()

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

Returns:

value or null for none

setName

public CustomBiddingAlgorithm setName(String name)

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

Parameters:

name - name or null for none

getPartnerId

public Long getPartnerId()

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

Returns:

value or null for none

setPartnerId

public CustomBiddingAlgorithm setPartnerId(Long partnerId)

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

Parameters:

partnerId - partnerId or null for none

getSharedAdvertiserIds

public List<Long> getSharedAdvertiserIds()

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`](/display- video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display- video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).

Returns:

value or null for none

setSharedAdvertiserIds

public CustomBiddingAlgorithm setSharedAdvertiserIds(List<Long> sharedAdvertiserIds)

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`](/display- video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display- video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).

Parameters:

sharedAdvertiserIds - sharedAdvertiserIds or null for none

set

public CustomBiddingAlgorithm set(String fieldName,
                                  Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public CustomBiddingAlgorithm clone()

Overrides:

clone in class com.google.api.client.json.GenericJson