Class: Google::Apis::DfareportingV3_5::FloodlightActivity

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



6074
6075
6076
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 6074

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) 


5901
5902
5903
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 5901

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) 


5908
5909
5910
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 5908

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV3_5::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue

Returns:



5913
5914
5915
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 5913

def advertiser_id_dimension_value
  @advertiser_id_dimension_value
end

#attribution_enabled ⇒ Boolean Also known as: attribution_enabled?

Whether the activity is enabled for attribution. Corresponds to the JSON property attributionEnabled

Returns:

  • (Boolean) 


5918
5919
5920
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 5918

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


5926
5927
5928
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 5926

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) 


5932
5933
5934
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 5932

def counting_method
  @counting_method
end

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

Dynamic floodlight tags. Corresponds to the JSON property defaultTags

Returns:



5937
5938
5939
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 5937

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) 


5943
5944
5945
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 5943

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) 


5949
5950
5951
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 5949

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) 


5954
5955
5956
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 5954

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) 


5960
5961
5962
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 5960

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) 


5965
5966
5967
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 5965

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) 


5973
5974
5975
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 5973

def floodlight_configuration_id
  @floodlight_configuration_id
end

#floodlight_configuration_id_dimension_value ⇒ Google::Apis::DfareportingV3_5::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property floodlightConfigurationIdDimensionValue

Returns:



5978
5979
5980
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 5978

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) 


5984
5985
5986
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 5984

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) 


5989
5990
5991
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 5989

def id
  @id
end

#id_dimension_value ⇒ Google::Apis::DfareportingV3_5::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



5994
5995
5996
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 5994

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) 


6000
6001
6002
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 6000

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) 


6006
6007
6008
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 6006

def name
  @name
end

#notes ⇒ String

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

Returns:

  • (String) 


6011
6012
6013
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 6011

def notes
  @notes
end

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

Publisher dynamic floodlight tags. Corresponds to the JSON property publisherTags

Returns:



6016
6017
6018
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 6016

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) 


6021
6022
6023
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 6021

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) 


6028
6029
6030
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 6028

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) 


6034
6035
6036
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 6034

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) 


6044
6045
6046
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 6044

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) 


6050
6051
6052
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 6050

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) 


6056
6057
6058
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 6056

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) 


6065
6066
6067
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 6065

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


6072
6073
6074
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 6072

def user_defined_variable_types
  @user_defined_variable_types
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 6079

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