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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ CreativeAssignment

Returns a new instance of CreativeAssignment.



4061
4062
4063
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4061

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

Instance Attribute Details

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


3974
3975
3976
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 3974

def active
  @active
end

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


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

def apply_event_tags
  @apply_event_tags
end

#click_through_urlGoogle::Apis::DfareportingV3_4::ClickThroughUrl

Click-through URL Corresponds to the JSON property clickThroughUrl



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

def click_through_url
  @click_through_url
end

#companion_creative_overridesArray<Google::Apis::DfareportingV3_4::CompanionClickThroughOverride>

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



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

def companion_creative_overrides
  @companion_creative_overrides
end

#creative_group_assignmentsArray<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



4001
4002
4003
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4001

def creative_group_assignments
  @creative_group_assignments
end

#creative_idFixnum

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

Returns:

  • (Fixnum)


4006
4007
4008
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4006

def creative_id
  @creative_id
end

#creative_id_dimension_valueGoogle::Apis::DfareportingV3_4::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property creativeIdDimensionValue



4011
4012
4013
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4011

def creative_id_dimension_value
  @creative_id_dimension_value
end

#end_timeDateTime

Date and time that the assigned creative should stop serving. Must be later than the start time. Corresponds to the JSON property endTime

Returns:

  • (DateTime)


4017
4018
4019
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4017

def end_time
  @end_time
end

#rich_media_exit_overridesArray<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


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

def rich_media_exit_overrides
  @rich_media_exit_overrides
end

#sequenceFixnum

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)


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

def sequence
  @sequence
end

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


4047
4048
4049
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4047

def ssl_compliant
  @ssl_compliant
end

#start_timeDateTime

Date and time that the assigned creative should start serving. Corresponds to the JSON property startTime

Returns:

  • (DateTime)


4053
4054
4055
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4053

def start_time
  @start_time
end

#weightFixnum

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)


4059
4060
4061
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4059

def weight
  @weight
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4066

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