Class: Google::Apis::DfareportingV5::BillingProfile

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dfareporting_v5/classes.rb,
lib/google/apis/dfareporting_v5/representations.rb,
lib/google/apis/dfareporting_v5/representations.rb

Overview

Contains properties of a Campaign Manager Billing Profile.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ BillingProfile

Returns a new instance of BillingProfile.



1442
1443
1444
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 1442

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

Instance Attribute Details

#consolidated_invoice ⇒ Boolean Also known as: consolidated_invoice?

Consolidated invoice option for this billing profile. Used to get a single, consolidated invoice across the chosen invoice level. Corresponds to the JSON property consolidatedInvoice

Returns:

  • (Boolean) 


1369
1370
1371
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 1369

def consolidated_invoice
  @consolidated_invoice
end

#country_code ⇒ String

Country code of this billing profile.This is a read-only field. Corresponds to the JSON property countryCode

Returns:

  • (String) 


1375
1376
1377
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 1375

def country_code
  @country_code
end

#currency_code ⇒ String

Billing currency code in ISO 4217 format.This is a read-only field. Corresponds to the JSON property currencyCode

Returns:

  • (String) 


1380
1381
1382
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 1380

def currency_code
  @currency_code
end

#id ⇒ Fixnum

ID of this billing profile. This is a read-only, auto-generated field. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


1385
1386
1387
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 1385

def id
  @id
end

#invoice_level ⇒ String

Invoice level for this billing profile. Used to group fees into separate invoices by account, advertiser, or campaign. Corresponds to the JSON property invoiceLevel

Returns:

  • (String) 


1391
1392
1393
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 1391

def invoice_level
  @invoice_level
end

#is_default ⇒ Boolean Also known as: is_default?

True if the billing profile is the account default profile. This is a read- only field. Corresponds to the JSON property isDefault

Returns:

  • (Boolean) 


1397
1398
1399
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 1397

def is_default
  @is_default
end

#kind ⇒ String

Identifies what kind of resource this is. Value: the fixed string " dfareporting#billingProfile". Corresponds to the JSON property kind

Returns:

  • (String) 


1404
1405
1406
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 1404

def kind
  @kind
end

#name ⇒ String

Name of this billing profile. This is a required field and must be less than 256 characters long and must be unique among billing profile in the same account. Corresponds to the JSON property name

Returns:

  • (String) 


1411
1412
1413
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 1411

def name
  @name
end

#payments_account_id ⇒ String

The ID of the payment account the billing profile belongs to. This is a read- only field. Corresponds to the JSON property paymentsAccountId

Returns:

  • (String) 


1417
1418
1419
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 1417

def 
  @payments_account_id
end

#payments_customer_id ⇒ String

The ID of the payment customer the billing profile belongs to. This is a read- only field. Corresponds to the JSON property paymentsCustomerId

Returns:

  • (String) 


1423
1424
1425
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 1423

def payments_customer_id
  @payments_customer_id
end

#purchase_order ⇒ String

Purchase order (PO) for this billing profile. This PO number is used in the invoices for all of the advertisers in this billing profile. Corresponds to the JSON property purchaseOrder

Returns:

  • (String) 


1429
1430
1431
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 1429

def purchase_order
  @purchase_order
end

#secondary_payments_customer_id ⇒ String

The ID of the secondary payment customer the billing profile belongs to. This is a read-only field. Corresponds to the JSON property secondaryPaymentsCustomerId

Returns:

  • (String) 


1435
1436
1437
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 1435

def secondary_payments_customer_id
  @secondary_payments_customer_id
end

#status ⇒ String

Status of this billing profile.This is a read-only field. Corresponds to the JSON property status

Returns:

  • (String) 


1440
1441
1442
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 1440

def status
  @status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 1447

def update!(**args)
  @consolidated_invoice = args[:consolidated_invoice] if args.key?(:consolidated_invoice)
  @country_code = args[:country_code] if args.key?(:country_code)
  @currency_code = args[:currency_code] if args.key?(:currency_code)
  @id = args[:id] if args.key?(:id)
  @invoice_level = args[:invoice_level] if args.key?(:invoice_level)
  @is_default = args[:is_default] if args.key?(:is_default)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @payments_account_id = args[:payments_account_id] if args.key?(:payments_account_id)
  @payments_customer_id = args[:payments_customer_id] if args.key?(:payments_customer_id)
  @purchase_order = args[:purchase_order] if args.key?(:purchase_order)
  @secondary_payments_customer_id = args[:secondary_payments_customer_id] if args.key?(:secondary_payments_customer_id)
  @status = args[:status] if args.key?(:status)
end