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

Inherits:
Object
  • Object
show all
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 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.

Instance Attribute Summary collapse

Instance Method Summary collapse

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.



493
494
495
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 493

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) 


422
423
424
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 422

def 
  @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) 


431
432
433
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 431

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) 


449
450
451
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 449

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) 


456
457
458
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 456

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) 


461
462
463
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 461

def entity_type
  @entity_type
end

#partner_client_id ⇒ String

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

Returns:

  • (String) 


473
474
475
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 473

def partner_client_id
  @partner_client_id
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) 


480
481
482
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 480

def role
  @role
end

#status ⇒ String

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

Returns:

  • (String) 


485
486
487
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 485

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) 


490
491
492
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 490

def visible_to_seller
  @visible_to_seller
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



498
499
500
501
502
503
504
505
506
507
508
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 498

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