Class: Google::Apis::Searchads360V0::GoogleAdsSearchads360V0ResourcesConversionAction

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

Overview

A conversion action.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAdsSearchads360V0ResourcesConversionAction

Returns a new instance of GoogleAdsSearchads360V0ResourcesConversionAction.



2828
2829
2830
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2828

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

Instance Attribute Details

#app_id ⇒ String

App ID for an app conversion action. Corresponds to the JSON property appId

Returns:

  • (String) 


2732
2733
2734
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2732

def app_id
  @app_id
end

#attribution_model_settings ⇒ Google::Apis::Searchads360V0::GoogleAdsSearchads360V0ResourcesConversionActionAttributionModelSettings

Settings related to this conversion action's attribution model. Corresponds to the JSON property attributionModelSettings

Returns:



2737
2738
2739
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2737

def attribution_model_settings
  @attribution_model_settings
end

#category ⇒ String

The category of conversions reported for this conversion action. Corresponds to the JSON property category

Returns:

  • (String) 


2742
2743
2744
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2742

def category
  @category
end

#click_through_lookback_window_days ⇒ Fixnum

The maximum number of days that may elapse between an interaction (for example, a click) and a conversion event. Corresponds to the JSON property clickThroughLookbackWindowDays

Returns:

  • (Fixnum) 


2748
2749
2750
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2748

def click_through_lookback_window_days
  @click_through_lookback_window_days
end

#creation_time ⇒ String

Output only. Timestamp of the Floodlight activity's creation, formatted in ISO 8601. Corresponds to the JSON property creationTime

Returns:

  • (String) 


2754
2755
2756
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2754

def creation_time
  @creation_time
end

#floodlight_settings ⇒ Google::Apis::Searchads360V0::GoogleAdsSearchads360V0ResourcesConversionActionFloodlightSettings

Settings related to a Floodlight conversion action. Corresponds to the JSON property floodlightSettings

Returns:



2759
2760
2761
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2759

def floodlight_settings
  @floodlight_settings
end

#id ⇒ Fixnum

Output only. The ID of the conversion action. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


2764
2765
2766
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2764

def id
  @id
end

#include_in_client_account_conversions_metric ⇒ Boolean Also known as: include_in_client_account_conversions_metric?

Whether this conversion action should be included in the " client_account_conversions" metric. Corresponds to the JSON property includeInClientAccountConversionsMetric

Returns:

  • (Boolean) 


2770
2771
2772
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2770

def 
  @include_in_client_account_conversions_metric
end

#include_in_conversions_metric ⇒ Boolean Also known as: include_in_conversions_metric?

Output only. Whether this conversion action should be included in the " conversions" metric. Corresponds to the JSON property includeInConversionsMetric

Returns:

  • (Boolean) 


2777
2778
2779
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2777

def include_in_conversions_metric
  @include_in_conversions_metric
end

#name ⇒ String

The name of the conversion action. This field is required and should not be empty when creating new conversion actions. Corresponds to the JSON property name

Returns:

  • (String) 


2784
2785
2786
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2784

def name
  @name
end

#owner_customer ⇒ String

Output only. The resource name of the conversion action owner customer, or null if this is a system-defined conversion action. Corresponds to the JSON property ownerCustomer

Returns:

  • (String) 


2790
2791
2792
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2790

def owner_customer
  @owner_customer
end

#primary_for_goal ⇒ Boolean Also known as: primary_for_goal?

If a conversion action's primary_for_goal bit is false, the conversion action is non-biddable for all campaigns regardless of their customer conversion goal or campaign conversion goal. However, custom conversion goals do not respect primary_for_goal, so if a campaign has a custom conversion goal configured with a primary_for_goal = false conversion action, that conversion action is still biddable. By default, primary_for_goal will be true if not set. In V9, primary_for_goal can only be set to false after creation through an 'update' operation because it's not declared as optional. Corresponds to the JSON property primaryForGoal

Returns:

  • (Boolean) 


2802
2803
2804
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2802

def primary_for_goal
  @primary_for_goal
end

#resource_name ⇒ String

Immutable. The resource name of the conversion action. Conversion action resource names have the form: customers/customer_id/conversionActions/ conversion_action_id` Corresponds to the JSON propertyresourceName`

Returns:

  • (String) 


2810
2811
2812
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2810

def resource_name
  @resource_name
end

#status ⇒ String

The status of this conversion action for conversion event accrual. Corresponds to the JSON property status

Returns:

  • (String) 


2815
2816
2817
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2815

def status
  @status
end

#type ⇒ String

Immutable. The type of this conversion action. Corresponds to the JSON property type

Returns:

  • (String) 


2820
2821
2822
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2820

def type
  @type
end

#value_settings ⇒ Google::Apis::Searchads360V0::GoogleAdsSearchads360V0ResourcesConversionActionValueSettings

Settings related to the value for conversion events associated with this conversion action. Corresponds to the JSON property valueSettings

Returns:



2826
2827
2828
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2826

def value_settings
  @value_settings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2833

def update!(**args)
  @app_id = args[:app_id] if args.key?(:app_id)
  @attribution_model_settings = args[:attribution_model_settings] if args.key?(:attribution_model_settings)
  @category = args[:category] if args.key?(:category)
  @click_through_lookback_window_days = args[:click_through_lookback_window_days] if args.key?(:click_through_lookback_window_days)
  @creation_time = args[:creation_time] if args.key?(:creation_time)
  @floodlight_settings = args[:floodlight_settings] if args.key?(:floodlight_settings)
  @id = args[:id] if args.key?(:id)
  @include_in_client_account_conversions_metric = args[:include_in_client_account_conversions_metric] if args.key?(:include_in_client_account_conversions_metric)
  @include_in_conversions_metric = args[:include_in_conversions_metric] if args.key?(:include_in_conversions_metric)
  @name = args[:name] if args.key?(:name)
  @owner_customer = args[:owner_customer] if args.key?(:owner_customer)
  @primary_for_goal = args[:primary_for_goal] if args.key?(:primary_for_goal)
  @resource_name = args[:resource_name] if args.key?(:resource_name)
  @status = args[:status] if args.key?(:status)
  @type = args[:type] if args.key?(:type)
  @value_settings = args[:value_settings] if args.key?(:value_settings)
end