Class: Google::Apis::DfareportingV2_6::FloodlightActivity

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dfareporting_v2_6/classes.rb,
generated/google/apis/dfareporting_v2_6/representations.rb,
generated/google/apis/dfareporting_v2_6/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.



5827
5828
5829
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 5827

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) 


5644
5645
5646
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 5644

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) 


5651
5652
5653
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 5651

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV2_6::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue

Returns:



5656
5657
5658
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 5656

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) 


5661
5662
5663
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 5661

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) 


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

def counting_method
  @counting_method
end

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

Dynamic floodlight tags. Corresponds to the JSON property defaultTags

Returns:



5672
5673
5674
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 5672

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) 


5678
5679
5680
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 5678

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) 


5684
5685
5686
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 5684

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) 


5689
5690
5691
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 5689

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) 


5695
5696
5697
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 5695

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) 


5700
5701
5702
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 5700

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) 


5708
5709
5710
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 5708

def floodlight_configuration_id
  @floodlight_configuration_id
end

#floodlight_configuration_id_dimension_value ⇒ Google::Apis::DfareportingV2_6::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property floodlightConfigurationIdDimensionValue

Returns:



5713
5714
5715
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 5713

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) 


5718
5719
5720
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 5718

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) 


5724
5725
5726
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 5724

def id
  @id
end

#id_dimension_value ⇒ Google::Apis::DfareportingV2_6::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



5729
5730
5731
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 5729

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) 


5734
5735
5736
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 5734

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) 


5741
5742
5743
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 5741

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) 


5747
5748
5749
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 5747

def name
  @name
end

#notes ⇒ String

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

Returns:

  • (String) 


5752
5753
5754
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 5752

def notes
  @notes
end

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

Publisher dynamic floodlight tags. Corresponds to the JSON property publisherTags

Returns:



5757
5758
5759
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 5757

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) 


5762
5763
5764
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 5762

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) 


5769
5770
5771
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 5769

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) 


5775
5776
5777
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 5775

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) 


5782
5783
5784
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 5782

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) 


5788
5789
5790
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 5788

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) 


5798
5799
5800
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 5798

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


5825
5826
5827
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 5825

def user_defined_variable_types
  @user_defined_variable_types
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 5832

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