Class: Google::Apis::DfareportingV3_2::FloodlightActivity

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



6190
6191
6192
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 6190

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) 


6025
6026
6027
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 6025

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) 


6032
6033
6034
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 6032

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV3_2::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue

Returns:



6037
6038
6039
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 6037

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) 


6044
6045
6046
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 6044

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) 


6050
6051
6052
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 6050

def counting_method
  @counting_method
end

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

Dynamic floodlight tags. Corresponds to the JSON property defaultTags

Returns:



6055
6056
6057
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 6055

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) 


6061
6062
6063
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 6061

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) 


6067
6068
6069
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 6067

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) 


6072
6073
6074
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 6072

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) 


6078
6079
6080
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 6078

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) 


6083
6084
6085
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 6083

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) 


6091
6092
6093
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 6091

def floodlight_configuration_id
  @floodlight_configuration_id
end

#floodlight_configuration_id_dimension_value ⇒ Google::Apis::DfareportingV3_2::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property floodlightConfigurationIdDimensionValue

Returns:



6096
6097
6098
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 6096

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) 


6102
6103
6104
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 6102

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) 


6107
6108
6109
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 6107

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) 


6113
6114
6115
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 6113

def id
  @id
end

#id_dimension_value ⇒ Google::Apis::DfareportingV3_2::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



6118
6119
6120
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 6118

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) 


6124
6125
6126
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 6124

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) 


6130
6131
6132
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 6130

def name
  @name
end

#notes ⇒ String

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

Returns:

  • (String) 


6135
6136
6137
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 6135

def notes
  @notes
end

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

Publisher dynamic floodlight tags. Corresponds to the JSON property publisherTags

Returns:



6140
6141
6142
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 6140

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) 


6145
6146
6147
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 6145

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) 


6152
6153
6154
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 6152

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) 


6158
6159
6160
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 6158

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) 


6165
6166
6167
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 6165

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) 


6171
6172
6173
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 6171

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) 


6181
6182
6183
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 6181

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


6188
6189
6190
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 6188

def user_defined_variable_types
  @user_defined_variable_types
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 6195

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