Class: Google::Apis::DfareportingV2_8::FloodlightActivity

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



6006
6007
6008
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 6006

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) 


5841
5842
5843
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 5841

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) 


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

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV2_8::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue

Returns:



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

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) 


5860
5861
5862
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 5860

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) 


5866
5867
5868
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 5866

def counting_method
  @counting_method
end

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

Dynamic floodlight tags. Corresponds to the JSON property defaultTags

Returns:



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

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) 


5877
5878
5879
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 5877

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) 


5883
5884
5885
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 5883

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) 


5888
5889
5890
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 5888

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) 


5894
5895
5896
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 5894

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) 


5899
5900
5901
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 5899

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) 


5907
5908
5909
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 5907

def floodlight_configuration_id
  @floodlight_configuration_id
end

#floodlight_configuration_id_dimension_value ⇒ Google::Apis::DfareportingV2_8::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property floodlightConfigurationIdDimensionValue

Returns:



5912
5913
5914
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 5912

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) 


5917
5918
5919
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 5917

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) 


5923
5924
5925
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 5923

def id
  @id
end

#id_dimension_value ⇒ Google::Apis::DfareportingV2_8::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



5928
5929
5930
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 5928

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) 


5933
5934
5935
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 5933

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) 


5940
5941
5942
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 5940

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) 


5946
5947
5948
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 5946

def name
  @name
end

#notes ⇒ String

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

Returns:

  • (String) 


5951
5952
5953
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 5951

def notes
  @notes
end

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

Publisher dynamic floodlight tags. Corresponds to the JSON property publisherTags

Returns:



5956
5957
5958
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 5956

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) 


5961
5962
5963
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 5961

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) 


5968
5969
5970
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 5968

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) 


5974
5975
5976
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 5974

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) 


5981
5982
5983
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 5981

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) 


5987
5988
5989
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 5987

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


5997
5998
5999
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 5997

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


6004
6005
6006
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 6004

def user_defined_variable_types
  @user_defined_variable_types
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 6011

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