Client (Ad Exchange Buyer API II v2beta1-rev20210613-1.32.1)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.adexchangebuyer2.v2beta1.model.Client

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Client
extends GenericJson
```
A client resource represents a client buyer—an agency, a brand, or an advertiser customer of the sponsor buyer. Users associated with the client buyer have restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the client buyer. All fields are required unless otherwise specified.
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 Ad Exchange Buyer API II. 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
  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

Client()

Constructors
Constructor and Description
`Client()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Client`	`clone()`
`Long`	`getClientAccountId()` The globally-unique numerical ID of the client.
`String`	`getClientName()` Name used to represent this client to publishers.
`Long`	`getEntityId()` Numerical identifier of the client entity.
`String`	`getEntityName()` The name of the entity.
`String`	`getEntityType()` An optional field for specifying the type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
`String`	`getPartnerClientId()` Optional arbitrary unique identifier of this client buyer from the standpoint of its Ad Exchange sponsor buyer.
`String`	`getRole()` The role which is assigned to the client buyer.
`String`	`getStatus()` The status of the client buyer.
`Boolean`	`getVisibleToSeller()` Whether the client buyer will be visible to sellers.
`Client`	`set(String fieldName, Object value)`
`Client`	`setClientAccountId(Long clientAccountId)` The globally-unique numerical ID of the client.
`Client`	`setClientName(String clientName)` Name used to represent this client to publishers.
`Client`	`setEntityId(Long entityId)` Numerical identifier of the client entity.
`Client`	`setEntityName(String entityName)` The name of the entity.
`Client`	`setEntityType(String entityType)` An optional field for specifying the type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
`Client`	`setPartnerClientId(String partnerClientId)` Optional arbitrary unique identifier of this client buyer from the standpoint of its Ad Exchange sponsor buyer.
`Client`	`setRole(String role)` The role which is assigned to the client buyer.
`Client`	`setStatus(String status)` The status of the client buyer.
`Client`	`setVisibleToSeller(Boolean visibleToSeller)` Whether the client buyer will be visible to sellers.

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
  - Client
```
public Client()
```
- Method Detail
  - getClientAccountId
```
public Long getClientAccountId()
```
    The globally-unique numerical ID of the client. The value of this field is ignored in create and update operations.
    
    Returns:
    
    value or null for none
  - setClientAccountId
```
public Client setClientAccountId(Long clientAccountId)
```
    The globally-unique numerical ID of the client. The value of this field is ignored in create and update operations.
    
    Parameters:
    
    clientAccountId - clientAccountId or null for none
  - getClientName
```
public String getClientName()
```
    Name used to represent this client to publishers. You may have multiple clients that map to the same entity, but for each client the combination of `clientName` and entity must be unique. You can specify this field as empty.
    
    Returns:
    
    value or null for none
  - setClientName
```
public Client setClientName(String clientName)
```
    Name used to represent this client to publishers. You may have multiple clients that map to the same entity, but for each client the combination of `clientName` and entity must be unique. You can specify this field as empty.
    
    Parameters:
    
    clientName - clientName or null for none
  - getEntityId
```
public Long getEntityId()
```
    Numerical identifier of the client entity. The entity can be an advertiser, a brand, or an agency. This identifier is unique among all the entities with the same type. The value of this field is ignored if the entity type is not provided. A list of all known advertisers with their identifiers is available in the [advertisers.txt](https://storage.googleapis.com/adx-rtb- dictionaries/advertisers.txt) file. A list of all known brands with their identifiers is available in the [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt) file. A list of all known agencies with their identifiers is available in the [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt) file.
    
    Returns:
    
    value or null for none
  - setEntityId
```
public Client setEntityId(Long entityId)
```
    Numerical identifier of the client entity. The entity can be an advertiser, a brand, or an agency. This identifier is unique among all the entities with the same type. The value of this field is ignored if the entity type is not provided. A list of all known advertisers with their identifiers is available in the [advertisers.txt](https://storage.googleapis.com/adx-rtb- dictionaries/advertisers.txt) file. A list of all known brands with their identifiers is available in the [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt) file. A list of all known agencies with their identifiers is available in the [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt) file.
    
    Parameters:
    
    entityId - entityId or null for none
  - getEntityName
```
public String getEntityName()
```
    The name of the entity. This field is automatically fetched based on the type and ID. The value of this field is ignored in create and update operations.
    
    Returns:
    
    value or null for none
  - setEntityName
```
public Client setEntityName(String entityName)
```
    The name of the entity. This field is automatically fetched based on the type and ID. The value of this field is ignored in create and update operations.
    
    Parameters:
    
    entityName - entityName or null for none
  - getEntityType
```
public String getEntityType()
```
    An optional field for specifying the type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
    
    Returns:
    
    value or null for none
  - setEntityType
```
public Client setEntityType(String entityType)
```
    An optional field for specifying the type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
    
    Parameters:
    
    entityType - entityType or null for none
  - getPartnerClientId
```
public String getPartnerClientId()
```
    Optional arbitrary unique identifier of this client buyer from the standpoint of its Ad Exchange sponsor buyer. This field can be used to associate a client buyer with the identifier in the namespace of its sponsor buyer, lookup client buyers by that identifier and verify whether an Ad Exchange counterpart of a given client buyer already exists. If present, must be unique among all the client buyers for its Ad Exchange sponsor buyer.
    
    Returns:
    
    value or null for none
  - setPartnerClientId
```
public Client setPartnerClientId(String partnerClientId)
```
    Optional arbitrary unique identifier of this client buyer from the standpoint of its Ad Exchange sponsor buyer. This field can be used to associate a client buyer with the identifier in the namespace of its sponsor buyer, lookup client buyers by that identifier and verify whether an Ad Exchange counterpart of a given client buyer already exists. If present, must be unique among all the client buyers for its Ad Exchange sponsor buyer.
    
    Parameters:
    
    partnerClientId - partnerClientId or null for none
  - getRole
```
public String getRole()
```
    The role which is assigned to the client buyer. Each role implies a set of permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`, `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
    
    Returns:
    
    value or null for none
  - setRole
```
public Client setRole(String role)
```
    The role which is assigned to the client buyer. Each role implies a set of permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`, `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
    
    Parameters:
    
    role - role or null for none
  - getStatus
```
public String getStatus()
```
    The status of the client buyer.
    
    Returns:
    
    value or null for none
  - setStatus
```
public Client setStatus(String status)
```
    The status of the client buyer.
    
    Parameters:
    
    status - status or null for none
  - getVisibleToSeller
```
public Boolean getVisibleToSeller()
```
    Whether the client buyer will be visible to sellers.
    
    Returns:
    
    value or null for none
  - setVisibleToSeller
```
public Client setVisibleToSeller(Boolean visibleToSeller)
```
    Whether the client buyer will be visible to sellers.
    
    Parameters:
    
    visibleToSeller - visibleToSeller or null for none
  - set
```
public Client set(String fieldName,
                  Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public Client clone()
```
    Overrides:
    
    clone in class GenericJson

Class Client

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Client

Method Detail

getClientAccountId

setClientAccountId

getClientName

setClientName

getEntityId

setEntityId

getEntityName

setEntityName

getEntityType

setEntityType

getPartnerClientId

setPartnerClientId

getRole

setRole

getStatus

setStatus

getVisibleToSeller

setVisibleToSeller

set

clone