Class: Google::Apis::DfareportingV3_4::CreativeAssignment

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

Creative Assignment.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CreativeAssignment

Returns a new instance of CreativeAssignment.



4041
4042
4043
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4041

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#active ⇒ Boolean Also known as: active?

Whether this creative assignment is active. When true, the creative will be included in the ad's rotation. Corresponds to the JSON property active

Returns:

  • (Boolean) 


3962
3963
3964
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 3962

def active
  @active
end

#apply_event_tags ⇒ Boolean Also known as: apply_event_tags?

Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO. Corresponds to the JSON property applyEventTags

Returns:

  • (Boolean) 


3971
3972
3973
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 3971

def apply_event_tags
  @apply_event_tags
end

#click_through_url ⇒ Google::Apis::DfareportingV3_4::ClickThroughUrl

Click-through URL Corresponds to the JSON property clickThroughUrl

Returns:



3977
3978
3979
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 3977

def click_through_url
  @click_through_url
end

#companion_creative_overrides ⇒ Array<Google::Apis::DfareportingV3_4::CompanionClickThroughOverride>

Companion creative overrides for this creative assignment. Applicable to video ads. Corresponds to the JSON property companionCreativeOverrides

Returns:



3983
3984
3985
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 3983

def companion_creative_overrides
  @companion_creative_overrides
end

#creative_group_assignments ⇒ Array<Google::Apis::DfareportingV3_4::CreativeGroupAssignment>

Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments. Corresponds to the JSON property creativeGroupAssignments

Returns:



3989
3990
3991
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 3989

def creative_group_assignments
  @creative_group_assignments
end

#creative_id ⇒ Fixnum

ID of the creative to be assigned. This is a required field. Corresponds to the JSON property creativeId

Returns:

  • (Fixnum) 


3994
3995
3996
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 3994

def creative_id
  @creative_id
end

#creative_id_dimension_value ⇒ Google::Apis::DfareportingV3_4::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property creativeIdDimensionValue

Returns:



3999
4000
4001
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 3999

def creative_id_dimension_value
  @creative_id_dimension_value
end

#end_time ⇒ DateTime

Corresponds to the JSON property endTime

Returns:

  • (DateTime) 


4004
4005
4006
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4004

def end_time
  @end_time
end

#rich_media_exit_overrides ⇒ Array<Google::Apis::DfareportingV3_4::RichMediaExitOverride>

Rich media exit overrides for this creative assignment. Applicable when the creative type is any of the following: - DISPLAY - RICH_MEDIA_INPAGE - RICH_MEDIA_INPAGE_FLOATING - RICH_MEDIA_IM_EXPAND - RICH_MEDIA_EXPANDING - RICH_MEDIA_INTERSTITIAL_FLOAT - RICH_MEDIA_MOBILE_IN_APP - RICH_MEDIA_MULTI_FLOATING - RICH_MEDIA_PEEL_DOWN - VPAID_LINEAR - VPAID_NON_LINEAR Corresponds to the JSON property richMediaExitOverrides

Returns:



4014
4015
4016
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4014

def rich_media_exit_overrides
  @rich_media_exit_overrides
end

#sequence ⇒ Fixnum

Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive. Corresponds to the JSON property sequence

Returns:

  • (Fixnum) 


4021
4022
4023
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4021

def sequence
  @sequence
end

#ssl_compliant ⇒ Boolean Also known as: ssl_compliant?

Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated. Corresponds to the JSON property sslCompliant

Returns:

  • (Boolean) 


4027
4028
4029
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4027

def ssl_compliant
  @ssl_compliant
end

#start_time ⇒ DateTime

Corresponds to the JSON property startTime

Returns:

  • (DateTime) 


4033
4034
4035
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4033

def start_time
  @start_time
end

#weight ⇒ Fixnum

Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1. Corresponds to the JSON property weight

Returns:

  • (Fixnum) 


4039
4040
4041
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4039

def weight
  @weight
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4046

def update!(**args)
  @active = args[:active] if args.key?(:active)
  @apply_event_tags = args[:apply_event_tags] if args.key?(:apply_event_tags)
  @click_through_url = args[:click_through_url] if args.key?(:click_through_url)
  @companion_creative_overrides = args[:companion_creative_overrides] if args.key?(:companion_creative_overrides)
  @creative_group_assignments = args[:creative_group_assignments] if args.key?(:creative_group_assignments)
  @creative_id = args[:creative_id] if args.key?(:creative_id)
  @creative_id_dimension_value = args[:creative_id_dimension_value] if args.key?(:creative_id_dimension_value)
  @end_time = args[:end_time] if args.key?(:end_time)
  @rich_media_exit_overrides = args[:rich_media_exit_overrides] if args.key?(:rich_media_exit_overrides)
  @sequence = args[:sequence] if args.key?(:sequence)
  @ssl_compliant = args[:ssl_compliant] if args.key?(:ssl_compliant)
  @start_time = args[:start_time] if args.key?(:start_time)
  @weight = args[:weight] if args.key?(:weight)
end