Class: Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonStoreSalesMetadata

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

Overview

Metadata for Store Sales Direct.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAdsSearchads360V23CommonStoreSalesMetadata

Returns a new instance of GoogleAdsSearchads360V23CommonStoreSalesMetadata.



11127
11128
11129
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 11127

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

Instance Attribute Details

#custom_key ⇒ String

Name of the store sales custom variable key. A predefined key that can be applied to the transaction and then later used for custom segmentation in reporting. Accessible only to customers on the allow-list. Corresponds to the JSON property customKey

Returns:

  • (String) 


11103
11104
11105
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 11103

def custom_key
  @custom_key
end

#loyalty_fraction ⇒ Float

This is the fraction of all transactions that are identifiable (for example, associated with any form of customer information). Required. The fraction needs to be between 0 and 1 (excluding 0). Corresponds to the JSON property loyaltyFraction

Returns:

  • (Float) 


11110
11111
11112
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 11110

def loyalty_fraction
  @loyalty_fraction
end

#third_party_metadata ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonStoreSalesThirdPartyMetadata

Metadata for a third party Store Sales. This product is only for customers on the allow-list. Contact your Google business development representative for details on the upload configuration. Corresponds to the JSON property thirdPartyMetadata

Returns:



11117
11118
11119
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 11117

def third_party_metadata
  @third_party_metadata
end

#transaction_upload_fraction ⇒ Float

This is the ratio of sales being uploaded compared to the overall sales that can be associated with a customer. Required. The fraction needs to be between 0 and 1 (excluding 0). For example, if you upload half the sales that you are able to associate with a customer, this would be 0.5. Corresponds to the JSON property transactionUploadFraction

Returns:

  • (Float) 


11125
11126
11127
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 11125

def transaction_upload_fraction
  @transaction_upload_fraction
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11132
11133
11134
11135
11136
11137
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 11132

def update!(**args)
  @custom_key = args[:custom_key] if args.key?(:custom_key)
  @loyalty_fraction = args[:loyalty_fraction] if args.key?(:loyalty_fraction)
  @third_party_metadata = args[:third_party_metadata] if args.key?(:third_party_metadata)
  @transaction_upload_fraction = args[:transaction_upload_fraction] if args.key?(:transaction_upload_fraction)
end