Class: Google::Apis::Adexchangebuyer2V2beta1::Client

Inherits:

Object

• Object
• Google::Apis::Adexchangebuyer2V2beta1::Client

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

generated/google/apis/adexchangebuyer2_v2beta1/classes.rb,
generated/google/apis/adexchangebuyer2_v2beta1/representations.rb,
generated/google/apis/adexchangebuyer2_v2beta1/representations.rb

Overview

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 Ad Exchange Marketplace and certain other sections of the Ad Exchange Buyer UI based on the role granted to the client buyer. All fields are required unless otherwise specified.

Instance Attribute Summary

• #client_account_id ⇒ Fixnum

  The globally-unique numerical ID of the client.

• #client_name ⇒ String

  Name used to represent this client to publishers.

• #entity_id ⇒ Fixnum

  Numerical identifier of the client entity.

• #entity_name ⇒ String

  The name of the entity.

• #entity_type ⇒ String

  The type of the client entity: ADVERTISER, BRAND, or AGENCY.

• #role ⇒ String

  The role which is assigned to the client buyer.

• #status ⇒ String

  The status of the client buyer.

• #visible_to_seller ⇒ Boolean (also: #visible_to_seller?)

  Whether the client buyer will be visible to sellers.

Instance Method Summary

• #initialize(**args) ⇒ Client constructor

  A new instance of Client.

• #update!(**args) ⇒ Object

  Update properties of this object.

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Client

Returns a new instance of Client

# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1461

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#client_account_id ⇒ Fixnum

The globally-unique numerical ID of the client. The value of this field is ignored in create and update operations. Corresponds to the JSON property clientAccountId

Returns:

• (Fixnum)

# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1447

def client_account_id
  @client_account_id
end

#client_name ⇒ String

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. Corresponds to the JSON property clientName

Returns:

• (String)

# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1410

def client_name
  @client_name
end

#entity_id ⇒ Fixnum

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. A list of all known advertisers with their identifiers is available in the advertisers.txt file. A list of all known brands with their identifiers is available in the brands.txt file. A list of all known agencies with their identifiers is available in the agencies.txt file. Corresponds to the JSON property entityId

Returns:

• (Fixnum)

# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1441

def entity_id
  @entity_id
end

#entity_name ⇒ String

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. Corresponds to the JSON property entityName

Returns:

• (String)

# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1454

def entity_name
  @entity_name
end

#entity_type ⇒ String

The type of the client entity: ADVERTISER, BRAND, or AGENCY. Corresponds to the JSON property entityType

Returns:

• (String)

# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1401

def entity_type
  @entity_type
end

#role ⇒ String

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. Corresponds to the JSON property role

Returns:

• (String)

# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1417

def role
  @role
end

#status ⇒ String

The status of the client buyer. Corresponds to the JSON property status

Returns:

• (String)

# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1459

def status
  @status
end

#visible_to_seller ⇒ Boolean Also known as: visible_to_seller?

Whether the client buyer will be visible to sellers. Corresponds to the JSON property visibleToSeller

Returns:

• (Boolean)

# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1422

def visible_to_seller
  @visible_to_seller
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1466

def update!(**args)
  @entity_type = args[:entity_type] if args.key?(:entity_type)
  @client_name = args[:client_name] if args.key?(:client_name)
  @role = args[:role] if args.key?(:role)
  @visible_to_seller = args[:visible_to_seller] if args.key?(:visible_to_seller)
  @entity_id = args[:entity_id] if args.key?(:entity_id)
  @client_account_id = args[:client_account_id] if args.key?(:client_account_id)
  @entity_name = args[:entity_name] if args.key?(:entity_name)
  @status = args[:status] if args.key?(:status)
end