Class: Google::Apis::DfareportingV2_5::FloodlightActivity

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

Overview

Contains properties of a Floodlight activity.

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

Returns a new instance of FloodlightActivity.



5725
5726
5727
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5725

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

Instance Attribute Details

#account_id ⇒ String

Account ID of this floodlight activity. This is a read-only field that can be left blank. Corresponds to the JSON property accountId

Returns:

  • (String) 


5542
5543
5544
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5542

def 
  @account_id
end

#advertiser_id ⇒ String

Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser. Corresponds to the JSON property advertiserId

Returns:

  • (String) 


5549
5550
5551
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5549

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV2_5::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue

Returns:



5554
5555
5556
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5554

def advertiser_id_dimension_value
  @advertiser_id_dimension_value
end

#cache_busting_type ⇒ String

Code type used for cache busting in the generated tag. Corresponds to the JSON property cacheBustingType

Returns:

  • (String) 


5559
5560
5561
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5559

def cache_busting_type
  @cache_busting_type
end

#counting_method ⇒ String

Counting method for conversions for this floodlight activity. This is a required field. Corresponds to the JSON property countingMethod

Returns:

  • (String) 


5565
5566
5567
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5565

def counting_method
  @counting_method
end

#default_tags ⇒ Array<Google::Apis::DfareportingV2_5::FloodlightActivityDynamicTag>

Dynamic floodlight tags. Corresponds to the JSON property defaultTags

Returns:



5570
5571
5572
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5570

def default_tags
  @default_tags
end

#expected_url ⇒ String

URL where this tag will be deployed. If specified, must be less than 256 characters long. Corresponds to the JSON property expectedUrl

Returns:

  • (String) 


5576
5577
5578
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5576

def expected_url
  @expected_url
end

#floodlight_activity_group_id ⇒ String

Floodlight activity group ID of this floodlight activity. This is a required field. Corresponds to the JSON property floodlightActivityGroupId

Returns:

  • (String) 


5582
5583
5584
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5582

def floodlight_activity_group_id
  @floodlight_activity_group_id
end

#floodlight_activity_group_name ⇒ String

Name of the associated floodlight activity group. This is a read-only field. Corresponds to the JSON property floodlightActivityGroupName

Returns:

  • (String) 


5587
5588
5589
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5587

def floodlight_activity_group_name
  @floodlight_activity_group_name
end

#floodlight_activity_group_tag_string ⇒ String

Tag string of the associated floodlight activity group. This is a read-only field. Corresponds to the JSON property floodlightActivityGroupTagString

Returns:

  • (String) 


5593
5594
5595
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5593

def floodlight_activity_group_tag_string
  @floodlight_activity_group_tag_string
end

#floodlight_activity_group_type ⇒ String

Type of the associated floodlight activity group. This is a read-only field. Corresponds to the JSON property floodlightActivityGroupType

Returns:

  • (String) 


5598
5599
5600
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5598

def floodlight_activity_group_type
  @floodlight_activity_group_type
end

#floodlight_configuration_id ⇒ String

Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration. Corresponds to the JSON property floodlightConfigurationId

Returns:

  • (String) 


5606
5607
5608
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5606

def floodlight_configuration_id
  @floodlight_configuration_id
end

#floodlight_configuration_id_dimension_value ⇒ Google::Apis::DfareportingV2_5::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property floodlightConfigurationIdDimensionValue

Returns:



5611
5612
5613
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5611

def floodlight_configuration_id_dimension_value
  @floodlight_configuration_id_dimension_value
end

#hidden ⇒ Boolean Also known as: hidden?

Whether this activity is archived. Corresponds to the JSON property hidden

Returns:

  • (Boolean) 


5616
5617
5618
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5616

def hidden
  @hidden
end

#id ⇒ String

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

Returns:

  • (String) 


5622
5623
5624
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5622

def id
  @id
end

#id_dimension_value ⇒ Google::Apis::DfareportingV2_5::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



5627
5628
5629
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5627

def id_dimension_value
  @id_dimension_value
end

#image_tag_enabled ⇒ Boolean Also known as: image_tag_enabled?

Whether the image tag is enabled for this activity. Corresponds to the JSON property imageTagEnabled

Returns:

  • (Boolean) 


5632
5633
5634
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5632

def image_tag_enabled
  @image_tag_enabled
end

#kind ⇒ String

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

Returns:

  • (String) 


5639
5640
5641
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5639

def kind
  @kind
end

#name ⇒ String

Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes. Corresponds to the JSON property name

Returns:

  • (String) 


5645
5646
5647
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5645

def name
  @name
end

#notes ⇒ String

General notes or implementation instructions for the tag. Corresponds to the JSON property notes

Returns:

  • (String) 


5650
5651
5652
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5650

def notes
  @notes
end

#publisher_tags ⇒ Array<Google::Apis::DfareportingV2_5::FloodlightActivityPublisherDynamicTag>

Publisher dynamic floodlight tags. Corresponds to the JSON property publisherTags

Returns:



5655
5656
5657
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5655

def publisher_tags
  @publisher_tags
end

#secure ⇒ Boolean Also known as: secure?

Whether this tag should use SSL. Corresponds to the JSON property secure

Returns:

  • (Boolean) 


5660
5661
5662
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5660

def secure
  @secure
end

#ssl_compliant ⇒ Boolean Also known as: ssl_compliant?

Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags. Corresponds to the JSON property sslCompliant

Returns:

  • (Boolean) 


5667
5668
5669
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5667

def ssl_compliant
  @ssl_compliant
end

#ssl_required ⇒ Boolean Also known as: ssl_required?

Whether this floodlight activity must be SSL-compliant. Corresponds to the JSON property sslRequired

Returns:

  • (Boolean) 


5673
5674
5675
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5673

def ssl_required
  @ssl_required
end

#subaccount_id ⇒ String

Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. Corresponds to the JSON property subaccountId

Returns:

  • (String) 


5680
5681
5682
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5680

def subaccount_id
  @subaccount_id
end

#tag_format ⇒ String

Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. Corresponds to the JSON property tagFormat

Returns:

  • (String) 


5686
5687
5688
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5686

def tag_format
  @tag_format
end

#tag_string ⇒ String

Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion. Corresponds to the JSON property tagString

Returns:

  • (String) 


5696
5697
5698
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5696

def tag_string
  @tag_string
end

#user_defined_variable_types ⇒ Array<String>

List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type. Acceptable values are:

  • "U1"
  • "U2"
  • "U3"
  • "U4"
  • "U5"
  • "U6"
  • "U7"
  • "U8"
  • "U9"
  • "U10"
  • "U11"
  • "U12"
  • "U13"
  • "U14"
  • "U15"
  • "U16"
  • "U17"
  • "U18"
  • "U19"
  • "U20" Corresponds to the JSON property userDefinedVariableTypes

Returns:

  • (Array<String>) 


5723
5724
5725
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5723

def user_defined_variable_types
  @user_defined_variable_types
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5730

def update!(**args)
  @account_id = args[:account_id] if args.key?(:account_id)
  @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id)
  @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value)
  @cache_busting_type = args[:cache_busting_type] if args.key?(:cache_busting_type)
  @counting_method = args[:counting_method] if args.key?(:counting_method)
  @default_tags = args[:default_tags] if args.key?(:default_tags)
  @expected_url = args[:expected_url] if args.key?(:expected_url)
  @floodlight_activity_group_id = args[:floodlight_activity_group_id] if args.key?(:floodlight_activity_group_id)
  @floodlight_activity_group_name = args[:floodlight_activity_group_name] if args.key?(:floodlight_activity_group_name)
  @floodlight_activity_group_tag_string = args[:floodlight_activity_group_tag_string] if args.key?(:floodlight_activity_group_tag_string)
  @floodlight_activity_group_type = args[:floodlight_activity_group_type] if args.key?(:floodlight_activity_group_type)
  @floodlight_configuration_id = args[:floodlight_configuration_id] if args.key?(:floodlight_configuration_id)
  @floodlight_configuration_id_dimension_value = args[:floodlight_configuration_id_dimension_value] if args.key?(:floodlight_configuration_id_dimension_value)
  @hidden = args[:hidden] if args.key?(:hidden)
  @id = args[:id] if args.key?(:id)
  @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value)
  @image_tag_enabled = args[:image_tag_enabled] if args.key?(:image_tag_enabled)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @notes = args[:notes] if args.key?(:notes)
  @publisher_tags = args[:publisher_tags] if args.key?(:publisher_tags)
  @secure = args[:secure] if args.key?(:secure)
  @ssl_compliant = args[:ssl_compliant] if args.key?(:ssl_compliant)
  @ssl_required = args[:ssl_required] if args.key?(:ssl_required)
  @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id)
  @tag_format = args[:tag_format] if args.key?(:tag_format)
  @tag_string = args[:tag_string] if args.key?(:tag_string)
  @user_defined_variable_types = args[:user_defined_variable_types] if args.key?(:user_defined_variable_types)
end