Class: Google::Apis::DfareportingV3_4::ClickThroughUrl

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

Overview

Click-through URL

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) ⇒ ClickThroughUrl

Returns a new instance of ClickThroughUrl.



2119
2120
2121
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2119

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

Instance Attribute Details

#computed_click_through_url ⇒ String

Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:

  • If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
  • If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
  • If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. Corresponds to the JSON property computedClickThroughUrl

Returns:

  • (String) 


2099
2100
2101
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2099

def computed_click_through_url
  @computed_click_through_url
end

#custom_click_through_url ⇒ String

Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. Corresponds to the JSON property customClickThroughUrl

Returns:

  • (String) 


2105
2106
2107
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2105

def custom_click_through_url
  @custom_click_through_url
end

#default_landing_page ⇒ Boolean Also known as: default_landing_page?

Whether the campaign default landing page is used. Corresponds to the JSON property defaultLandingPage

Returns:

  • (Boolean) 


2110
2111
2112
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2110

def default_landing_page
  @default_landing_page
end

#landing_page_id ⇒ Fixnum

ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. Corresponds to the JSON property landingPageId

Returns:

  • (Fixnum) 


2117
2118
2119
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2117

def landing_page_id
  @landing_page_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2124
2125
2126
2127
2128
2129
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 2124

def update!(**args)
  @computed_click_through_url = args[:computed_click_through_url] if args.key?(:computed_click_through_url)
  @custom_click_through_url = args[:custom_click_through_url] if args.key?(:custom_click_through_url)
  @default_landing_page = args[:default_landing_page] if args.key?(:default_landing_page)
  @landing_page_id = args[:landing_page_id] if args.key?(:landing_page_id)
end