Class: Google::Apis::DfareportingV3_4::FloodlightActivity

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



6436
6437
6438
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 6436

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) 


6268
6269
6270
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 6268

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) 


6275
6276
6277
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 6275

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV3_4::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue

Returns:



6280
6281
6282
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 6280

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) 


6287
6288
6289
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 6287

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) 


6293
6294
6295
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 6293

def counting_method
  @counting_method
end

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

Dynamic floodlight tags. Corresponds to the JSON property defaultTags

Returns:



6298
6299
6300
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 6298

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) 


6304
6305
6306
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 6304

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) 


6310
6311
6312
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 6310

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) 


6315
6316
6317
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 6315

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) 


6321
6322
6323
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 6321

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) 


6326
6327
6328
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 6326

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) 


6334
6335
6336
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 6334

def floodlight_configuration_id
  @floodlight_configuration_id
end

#floodlight_configuration_id_dimension_value ⇒ Google::Apis::DfareportingV3_4::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property floodlightConfigurationIdDimensionValue

Returns:



6339
6340
6341
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 6339

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) 


6345
6346
6347
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 6345

def floodlight_tag_type
  @floodlight_tag_type
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


6350
6351
6352
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 6350

def id
  @id
end

#id_dimension_value ⇒ Google::Apis::DfareportingV3_4::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



6355
6356
6357
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 6355

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) 


6361
6362
6363
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 6361

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) 


6367
6368
6369
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 6367

def name
  @name
end

#notes ⇒ String

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

Returns:

  • (String) 


6372
6373
6374
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 6372

def notes
  @notes
end

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

Publisher dynamic floodlight tags. Corresponds to the JSON property publisherTags

Returns:



6377
6378
6379
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 6377

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) 


6382
6383
6384
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 6382

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) 


6389
6390
6391
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 6389

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) 


6395
6396
6397
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 6395

def ssl_required
  @ssl_required
end

#status ⇒ String

The status of the activity. This can only be set to ACTIVE or ARCHIVED_AND_DISABLED. The ARCHIVED status is no longer supported and cannot be set for Floodlight activities. The DISABLED_POLICY status indicates that a Floodlight activity is violating Google policy. Contact your account manager for more information. Corresponds to the JSON property status

Returns:

  • (String) 


6405
6406
6407
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 6405

def status
  @status
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) 


6411
6412
6413
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 6411

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) 


6417
6418
6419
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 6417

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) 


6427
6428
6429
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 6427

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


6434
6435
6436
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 6434

def user_defined_variable_types
  @user_defined_variable_types
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 6441

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