Class: Google::Apis::DfareportingV2_1::FloodlightActivity

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

Overview

Contains properties of a Floodlight activity.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ FloodlightActivity

Returns a new instance of FloodlightActivity.



5276
5277
5278
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 5276

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) 


5093
5094
5095
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 5093

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) 


5100
5101
5102
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 5100

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV2_1::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue

Returns:



5105
5106
5107
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 5105

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) 


5110
5111
5112
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 5110

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) 


5116
5117
5118
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 5116

def counting_method
  @counting_method
end

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

Dynamic floodlight tags. Corresponds to the JSON property defaultTags

Returns:



5121
5122
5123
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 5121

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) 


5127
5128
5129
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 5127

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) 


5133
5134
5135
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 5133

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) 


5138
5139
5140
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 5138

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) 


5144
5145
5146
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 5144

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) 


5149
5150
5151
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 5149

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) 


5157
5158
5159
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 5157

def floodlight_configuration_id
  @floodlight_configuration_id
end

#floodlight_configuration_id_dimension_value ⇒ Google::Apis::DfareportingV2_1::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property floodlightConfigurationIdDimensionValue

Returns:



5162
5163
5164
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 5162

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) 


5167
5168
5169
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 5167

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) 


5173
5174
5175
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 5173

def id
  @id
end

#id_dimension_value ⇒ Google::Apis::DfareportingV2_1::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



5178
5179
5180
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 5178

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) 


5183
5184
5185
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 5183

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) 


5190
5191
5192
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 5190

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) 


5196
5197
5198
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 5196

def name
  @name
end

#notes ⇒ String

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

Returns:

  • (String) 


5201
5202
5203
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 5201

def notes
  @notes
end

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

Publisher dynamic floodlight tags. Corresponds to the JSON property publisherTags

Returns:



5206
5207
5208
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 5206

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) 


5211
5212
5213
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 5211

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) 


5218
5219
5220
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 5218

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) 


5224
5225
5226
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 5224

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) 


5231
5232
5233
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 5231

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) 


5237
5238
5239
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 5237

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) 


5247
5248
5249
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 5247

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


5274
5275
5276
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 5274

def user_defined_variable_types
  @user_defined_variable_types
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 5281

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