Class: Google::Apis::DfareportingV3_3::FloodlightActivity

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

Overview

Contains properties of a Floodlight activity.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ FloodlightActivity

Returns a new instance of FloodlightActivity.



5902
5903
5904
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5902

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

Instance Attribute Details

#account_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


5738
5739
5740
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5738

def 
  @account_id
end

#advertiser_id ⇒ Fixnum

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:

  • (Fixnum) 


5745
5746
5747
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5745

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV3_3::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue

Returns:



5750
5751
5752
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5750

def advertiser_id_dimension_value
  @advertiser_id_dimension_value
end

#cache_busting_type ⇒ String

Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING. Corresponds to the JSON property cacheBustingType

Returns:

  • (String) 


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

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) 


5763
5764
5765
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5763

def counting_method
  @counting_method
end

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

Dynamic floodlight tags. Corresponds to the JSON property defaultTags

Returns:



5768
5769
5770
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5768

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) 


5774
5775
5776
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5774

def expected_url
  @expected_url
end

#floodlight_activity_group_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


5780
5781
5782
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5780

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) 


5785
5786
5787
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5785

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) 


5791
5792
5793
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5791

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) 


5796
5797
5798
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5796

def floodlight_activity_group_type
  @floodlight_activity_group_type
end

#floodlight_configuration_id ⇒ Fixnum

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:

  • (Fixnum) 


5804
5805
5806
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5804

def floodlight_configuration_id
  @floodlight_configuration_id
end

#floodlight_configuration_id_dimension_value ⇒ Google::Apis::DfareportingV3_3::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property floodlightConfigurationIdDimensionValue

Returns:



5809
5810
5811
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5809

def floodlight_configuration_id_dimension_value
  @floodlight_configuration_id_dimension_value
end

#floodlight_tag_type ⇒ String

The type of Floodlight tag this activity will generate. This is a required field. Corresponds to the JSON property floodlightTagType

Returns:

  • (String) 


5815
5816
5817
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5815

def floodlight_tag_type
  @floodlight_tag_type
end

#hidden ⇒ Boolean Also known as: hidden?

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

Returns:

  • (Boolean) 


5820
5821
5822
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5820

def hidden
  @hidden
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


5826
5827
5828
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5826

def id
  @id
end

#id_dimension_value ⇒ Google::Apis::DfareportingV3_3::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



5831
5832
5833
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5831

def id_dimension_value
  @id_dimension_value
end

#kind ⇒ String

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

Returns:

  • (String) 


5837
5838
5839
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5837

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) 


5843
5844
5845
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5843

def name
  @name
end

#notes ⇒ String

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

Returns:

  • (String) 


5848
5849
5850
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5848

def notes
  @notes
end

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

Publisher dynamic floodlight tags. Corresponds to the JSON property publisherTags

Returns:



5853
5854
5855
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5853

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) 


5858
5859
5860
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5858

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) 


5865
5866
5867
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5865

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) 


5871
5872
5873
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5871

def ssl_required
  @ssl_required
end

#subaccount_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


5878
5879
5880
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5878

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) 


5884
5885
5886
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5884

def tag_format
  @tag_format
end

#tag_string ⇒ String

Value of the cat= parameter 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-z0-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) 


5893
5894
5895
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5893

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-100]=" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive. Corresponds to the JSON property userDefinedVariableTypes

Returns:

  • (Array<String>) 


5900
5901
5902
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5900

def user_defined_variable_types
  @user_defined_variable_types
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5907

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)
  @floodlight_tag_type = args[:floodlight_tag_type] if args.key?(:floodlight_tag_type)
  @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)
  @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