Class: Google::Apis::Adexchangebuyer2V2beta1::AdExchangeBuyerIIService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
generated/google/apis/adexchangebuyer2_v2beta1/service.rb

Overview

Ad Exchange Buyer API II

Accesses the latest features for managing Ad Exchange accounts, Real-Time Bidding configurations and auction metrics, and Marketplace programmatic deals.

Examples:

require 'google/apis/adexchangebuyer2_v2beta1'

Adexchangebuyer2 = Google::Apis::Adexchangebuyer2V2beta1 # Alias the module
service = Adexchangebuyer2::AdExchangeBuyerIIService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ AdExchangeBuyerIIService

Returns a new instance of AdExchangeBuyerIIService



46
47
48
49
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 46

def initialize
  super('https://adexchangebuyer.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



39
40
41
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 39

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



44
45
46
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#add_deal_association(account_id, creative_id, add_deal_association_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::Empty

Associate an existing deal with a creative.

Parameters:

  • account_id (String) —

    The account the creative belongs to.

  • creative_id (String) —

    The ID of the creative associated with the deal.

  • add_deal_association_request_object (Google::Apis::Adexchangebuyer2V2beta1::AddDealAssociationRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



787
788
789
790
791
792
793
794
795
796
797
798
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 787

def add_deal_association(, creative_id, add_deal_association_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add', options)
  command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::AddDealAssociationRequest::Representation
  command.request_object = add_deal_association_request_object
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Empty::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Empty
  command.params['accountId'] =  unless .nil?
  command.params['creativeId'] = creative_id unless creative_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_account_client(account_id, client_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::Client

Creates a new client buyer.

Parameters:

  • account_id (Fixnum) —

    Unique numerical account ID for the buyer of which the client buyer is a customer; the sponsor buyer to create a client for. (required)

  • client_object (Google::Apis::Adexchangebuyer2V2beta1::Client) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



184
185
186
187
188
189
190
191
192
193
194
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 184

def (, client_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2beta1/accounts/{accountId}/clients', options)
  command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::Client::Representation
  command.request_object = client_object
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Client::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Client
  command.params['accountId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_account_client_invitation(account_id, client_account_id, client_user_invitation_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ClientUserInvitation

Creates and sends out an email invitation to access an Ad Exchange client buyer account.

Parameters:

  • account_id (Fixnum) —

    Numerical account ID of the client's sponsor buyer. (required)

  • client_account_id (Fixnum) —

    Numerical account ID of the client buyer that the user should be associated with. (required)

  • client_user_invitation_object (Google::Apis::Adexchangebuyer2V2beta1::ClientUserInvitation) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 309

def (, , client_user_invitation_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations', options)
  command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::ClientUserInvitation::Representation
  command.request_object = client_user_invitation_object
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ClientUserInvitation::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ClientUserInvitation
  command.params['accountId'] =  unless .nil?
  command.params['clientAccountId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_account_creative(account_id, creative_object = nil, duplicate_id_mode: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::Creative

Creates a creative.

Parameters:

  • account_id (String) —

    The account that this creative belongs to. Can be used to filter the response of the creatives.list method.

  • creative_object (Google::Apis::Adexchangebuyer2V2beta1::Creative) (defaults to: nil)
  • duplicate_id_mode (String) —

    Indicates if multiple creatives can share an ID or not. Default is NO_DUPLICATES (one ID per creative).

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



537
538
539
540
541
542
543
544
545
546
547
548
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 537

def (, creative_object = nil, duplicate_id_mode: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2beta1/accounts/{accountId}/creatives', options)
  command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::Creative::Representation
  command.request_object = creative_object
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Creative::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Creative
  command.params['accountId'] =  unless .nil?
  command.query['duplicateIdMode'] = duplicate_id_mode unless duplicate_id_mode.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_account_client(account_id, client_account_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::Client

Gets a client buyer with a given client account ID.

Parameters:

  • account_id (Fixnum) —

    Numerical account ID of the client's sponsor buyer. (required)

  • client_account_id (Fixnum) —

    Numerical account ID of the client buyer to retrieve. (required)

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



73
74
75
76
77
78
79
80
81
82
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 73

def (, , fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta1/accounts/{accountId}/clients/{clientAccountId}', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Client::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Client
  command.params['accountId'] =  unless .nil?
  command.params['clientAccountId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_account_client_invitation(account_id, client_account_id, invitation_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ClientUserInvitation

Retrieves an existing client user invitation.

Parameters:

  • account_id (Fixnum) —

    Numerical account ID of the client's sponsor buyer. (required)

  • client_account_id (Fixnum) —

    Numerical account ID of the client buyer that the user invitation to be retrieved is associated with. (required)

  • invitation_id (Fixnum) —

    Numerical identifier of the user invitation to retrieve. (required)

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



221
222
223
224
225
226
227
228
229
230
231
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 221

def (, , invitation_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ClientUserInvitation::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ClientUserInvitation
  command.params['accountId'] =  unless .nil?
  command.params['clientAccountId'] =  unless .nil?
  command.params['invitationId'] = invitation_id unless invitation_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_account_client_user(account_id, client_account_id, user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ClientUser

Retrieves an existing client user.

Parameters:

  • account_id (Fixnum) —

    Numerical account ID of the client's sponsor buyer. (required)

  • client_account_id (Fixnum) —

    Numerical account ID of the client buyer that the user to be retrieved is associated with. (required)

  • user_id (Fixnum) —

    Numerical identifier of the user to retrieve. (required)

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



397
398
399
400
401
402
403
404
405
406
407
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 397

def (, , user_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ClientUser::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ClientUser
  command.params['accountId'] =  unless .nil?
  command.params['clientAccountId'] =  unless .nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_account_creative(account_id, creative_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::Creative

Gets a creative.

Parameters:

  • account_id (String) —

    The account the creative belongs to.

  • creative_id (String) —

    The ID of the creative to retrieve.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



610
611
612
613
614
615
616
617
618
619
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 610

def (, creative_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta1/accounts/{accountId}/creatives/{creativeId}', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Creative::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Creative
  command.params['accountId'] =  unless .nil?
  command.params['creativeId'] = creative_id unless creative_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_account_client_invitations(account_id, client_account_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListClientUserInvitationsResponse

Lists all the client users invitations for a client with a given account ID.

Parameters:

  • account_id (Fixnum) —

    Numerical account ID of the client's sponsor buyer. (required)

  • client_account_id (String) —

    Numerical account ID of the client buyer to list invitations for. (required) You must either specify a string representation of a numerical account identifier or the - character to list all the invitations for all the clients of a given sponsor buyer.

  • page_size (Fixnum) —

    Requested page size. Server may return fewer clients than requested. If unspecified, server will pick an appropriate default.

  • page_token (String) —

    A token identifying a page of results the server should return. Typically, this is the value of ListClientUserInvitationsResponse.nextPageToken returned from the previous call to the clients.invitations.list method.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 271

def (, , page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListClientUserInvitationsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListClientUserInvitationsResponse
  command.params['accountId'] =  unless .nil?
  command.params['clientAccountId'] =  unless .nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_account_client_users(account_id, client_account_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListClientUsersResponse

Lists all the known client users for a specified sponsor buyer account ID.

Parameters:

  • account_id (Fixnum) —

    Numerical account ID of the sponsor buyer of the client to list users for. (required)

  • client_account_id (String) —

    The account ID of the client buyer to list users for. (required) You must specify either a string representation of a numerical account identifier or the - character to list all the client users for all the clients of a given sponsor buyer.

  • page_size (Fixnum) —

    Requested page size. The server may return fewer clients than requested. If unspecified, the server will pick an appropriate default.

  • page_token (String) —

    A token identifying a page of results the server should return. Typically, this is the value of ListClientUsersResponse.nextPageToken returned from the previous call to the accounts.clients.users.list method.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 359

def (, , page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta1/accounts/{accountId}/clients/{clientAccountId}/users', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListClientUsersResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListClientUsersResponse
  command.params['accountId'] =  unless .nil?
  command.params['clientAccountId'] =  unless .nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_account_clients(account_id, page_token: nil, page_size: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListClientsResponse

Lists all the clients for the current sponsor buyer.

Parameters:

  • account_id (Fixnum) —

    Unique numerical account ID of the sponsor buyer to list the clients for.

  • page_token (String) —

    A token identifying a page of results the server should return. Typically, this is the value of ListClientsResponse.nextPageToken returned from the previous call to the accounts.clients.list method.

  • page_size (Fixnum) —

    Requested page size. The server may return fewer clients than requested. If unspecified, the server will pick an appropriate default.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



113
114
115
116
117
118
119
120
121
122
123
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 113

def (, page_token: nil, page_size: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta1/accounts/{accountId}/clients', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListClientsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListClientsResponse
  command.params['accountId'] =  unless .nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_account_creative_deal_associations(account_id, creative_id, page_token: nil, page_size: nil, query: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListDealAssociationsResponse

List all creative-deal associations.

Parameters:

  • account_id (String) —

    The account to list the associations from. Specify "-" to list all creatives the current user has access to.

  • creative_id (String) —

    The creative ID to list the associations from. Specify "-" to list all creatives under the above account.

  • page_token (String) —

    A token identifying a page of results the server should return. Typically, this is the value of ListDealAssociationsResponse.next_page_token returned from the previous call to 'ListDealAssociations' method.

  • page_size (Fixnum) —

    Requested page size. Server may return fewer associations than requested. If unspecified, server will pick an appropriate default.

  • query (String) —

    An optional query string to filter deal associations. If no filter is specified, all associations will be returned. Supported queries are:

    • accountId=account_id_string
    • creativeId=creative_id_string
    • dealsId=deals_id_string
    • dealsStatus:`approved, conditionally_approved, disapproved, not_checked`
    • openAuctionStatus:`approved, conditionally_approved, disapproved, not_checked`

    Example: 'dealsId=12345 AND dealsStatus:disapproved'

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



750
751
752
753
754
755
756
757
758
759
760
761
762
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 750

def (, creative_id, page_token: nil, page_size: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListDealAssociationsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListDealAssociationsResponse
  command.params['accountId'] =  unless .nil?
  command.params['creativeId'] = creative_id unless creative_id.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['query'] = query unless query.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_account_creatives(account_id, page_token: nil, page_size: nil, query: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListCreativesResponse

Lists creatives.

Parameters:

  • account_id (String) —

    The account to list the creatives from. Specify "-" to list all creatives the current user has access to.

  • page_token (String) —

    A token identifying a page of results the server should return. Typically, this is the value of ListCreativesResponse.next_page_token returned from the previous call to 'ListCreatives' method.

  • page_size (Fixnum) —

    Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available via another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive.

  • query (String) —

    An optional query string to filter creatives. If no filter is specified, all active creatives will be returned. Supported queries are:

    • accountId=account_id_string
    • creativeId=creative_id_string
    • dealsStatus: `approved, conditionally_approved, disapproved, not_checked`
    • openAuctionStatus: `approved, conditionally_approved, disapproved, not_checked`
    • attribute: `a numeric attribute from the list of attributes`
    • disapprovalReason: `a reason from DisapprovalReason

    Example: 'accountId=12345 AND (dealsStatus:disapproved AND disapprovalReason: unacceptable_content) OR attribute:47'

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def (, page_token: nil, page_size: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta1/accounts/{accountId}/creatives', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListCreativesResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListCreativesResponse
  command.params['accountId'] =  unless .nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['query'] = query unless query.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#remove_deal_association(account_id, creative_id, remove_deal_association_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::Empty

Remove the association between a deal and a creative.

Parameters:

  • account_id (String) —

    The account the creative belongs to.

  • creative_id (String) —

    The ID of the creative associated with the deal.

  • remove_deal_association_request_object (Google::Apis::Adexchangebuyer2V2beta1::RemoveDealAssociationRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



823
824
825
826
827
828
829
830
831
832
833
834
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 823

def remove_deal_association(, creative_id, remove_deal_association_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove', options)
  command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::RemoveDealAssociationRequest::Representation
  command.request_object = remove_deal_association_request_object
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Empty::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Empty
  command.params['accountId'] =  unless .nil?
  command.params['creativeId'] = creative_id unless creative_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#stop_watching_creative(account_id, creative_id, stop_watching_creative_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::Empty

Stops watching a creative. Will stop push notifications being sent to the topics when the creative changes status.

Parameters:

  • account_id (String) —

    The account of the creative to stop notifications for.

  • creative_id (String) —

    The creative ID of the creative to stop notifications for. Specify "-" to specify stopping account level notifications.

  • stop_watching_creative_request_object (Google::Apis::Adexchangebuyer2V2beta1::StopWatchingCreativeRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



575
576
577
578
579
580
581
582
583
584
585
586
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 575

def stop_watching_creative(, creative_id, stop_watching_creative_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching', options)
  command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::StopWatchingCreativeRequest::Representation
  command.request_object = stop_watching_creative_request_object
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Empty::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Empty
  command.params['accountId'] =  unless .nil?
  command.params['creativeId'] = creative_id unless creative_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_account_client(account_id, client_account_id, client_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::Client

Updates an existing client buyer.

Parameters:

  • account_id (Fixnum) —

    Unique numerical account ID for the buyer of which the client buyer is a customer; the sponsor buyer to update a client for. (required)

  • client_account_id (Fixnum) —

    Unique numerical account ID of the client to update. (required)

  • client_object (Google::Apis::Adexchangebuyer2V2beta1::Client) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 149

def (, , client_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:put, 'v2beta1/accounts/{accountId}/clients/{clientAccountId}', options)
  command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::Client::Representation
  command.request_object = client_object
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Client::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Client
  command.params['accountId'] =  unless .nil?
  command.params['clientAccountId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_account_client_user(account_id, client_account_id, user_id, client_user_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ClientUser

Updates an existing client user. Only the user status can be changed on update.

Parameters:

  • account_id (Fixnum) —

    Numerical account ID of the client's sponsor buyer. (required)

  • client_account_id (Fixnum) —

    Numerical account ID of the client buyer that the user to be retrieved is associated with. (required)

  • user_id (Fixnum) —

    Numerical identifier of the user to retrieve. (required)

  • client_user_object (Google::Apis::Adexchangebuyer2V2beta1::ClientUser) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 436

def (, , user_id, client_user_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:put, 'v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}', options)
  command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::ClientUser::Representation
  command.request_object = client_user_object
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ClientUser::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ClientUser
  command.params['accountId'] =  unless .nil?
  command.params['clientAccountId'] =  unless .nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_account_creative(account_id, creative_id, creative_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::Creative

Updates a creative.

Parameters:

  • account_id (String) —

    The account that this creative belongs to. Can be used to filter the response of the creatives.list method.

  • creative_id (String) —

    The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method.

  • creative_object (Google::Apis::Adexchangebuyer2V2beta1::Creative) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



691
692
693
694
695
696
697
698
699
700
701
702
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 691

def (, creative_id, creative_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:put, 'v2beta1/accounts/{accountId}/creatives/{creativeId}', options)
  command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::Creative::Representation
  command.request_object = creative_object
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Creative::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Creative
  command.params['accountId'] =  unless .nil?
  command.params['creativeId'] = creative_id unless creative_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#watch_creative(account_id, creative_id, watch_creative_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::Empty

Watches a creative. Will result in push notifications being sent to the topic when the creative changes status.

Parameters:

  • account_id (String) —

    The account of the creative to watch.

  • creative_id (String) —

    The creative ID to watch for status changes. Specify "-" to watch all creatives under the above account. If both creative-level and account-level notifications are sent, only a single notification will be sent to the creative-level notification topic.

  • watch_creative_request_object (Google::Apis::Adexchangebuyer2V2beta1::WatchCreativeRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 649

def watch_creative(, creative_id, watch_creative_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2beta1/accounts/{accountId}/creatives/{creativeId}:watch', options)
  command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::WatchCreativeRequest::Representation
  command.request_object = watch_creative_request_object
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Empty::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Empty
  command.params['accountId'] =  unless .nil?
  command.params['creativeId'] = creative_id unless creative_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end