Class: Google::Apis::DfareportingV2_6::CreativeAssignment
- Inherits:
-
Object
- Object
- Google::Apis::DfareportingV2_6::CreativeAssignment
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/dfareporting_v2_6/classes.rb,
generated/google/apis/dfareporting_v2_6/representations.rb,
generated/google/apis/dfareporting_v2_6/representations.rb
Overview
Creative Assignment.
Instance Attribute Summary collapse
-
#active ⇒ Boolean
(also: #active?)
Whether this creative assignment is active.
-
#apply_event_tags ⇒ Boolean
(also: #apply_event_tags?)
Whether applicable event tags should fire when this creative assignment is rendered.
-
#click_through_url ⇒ Google::Apis::DfareportingV2_6::ClickThroughUrl
Click-through URL Corresponds to the JSON property
clickThroughUrl
. -
#companion_creative_overrides ⇒ Array<Google::Apis::DfareportingV2_6::CompanionClickThroughOverride>
Companion creative overrides for this creative assignment.
-
#creative_group_assignments ⇒ Array<Google::Apis::DfareportingV2_6::CreativeGroupAssignment>
Creative group assignments for this creative assignment.
-
#creative_id ⇒ String
ID of the creative to be assigned.
-
#creative_id_dimension_value ⇒ Google::Apis::DfareportingV2_6::DimensionValue
Represents a DimensionValue resource.
-
#end_time ⇒ DateTime
Date and time that the assigned creative should stop serving.
-
#rich_media_exit_overrides ⇒ Array<Google::Apis::DfareportingV2_6::RichMediaExitOverride>
Rich media exit overrides for this creative assignment.
-
#sequence ⇒ Fixnum
Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
-
#ssl_compliant ⇒ Boolean
(also: #ssl_compliant?)
Whether the creative to be assigned is SSL-compliant.
-
#start_time ⇒ DateTime
Date and time that the assigned creative should start serving.
-
#weight ⇒ Fixnum
Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
Instance Method Summary collapse
-
#initialize(**args) ⇒ CreativeAssignment
constructor
A new instance of CreativeAssignment.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ CreativeAssignment
Returns a new instance of CreativeAssignment.
3657 3658 3659 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 3657 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
3571 3572 3573 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 3571 def active @active end |
#apply_event_tags ⇒ Boolean Also known as:
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
3580 3581 3582 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 3580 def @apply_event_tags end |
#click_through_url ⇒ Google::Apis::DfareportingV2_6::ClickThroughUrl
Click-through URL
Corresponds to the JSON property clickThroughUrl
3586 3587 3588 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 3586 def click_through_url @click_through_url end |
#companion_creative_overrides ⇒ Array<Google::Apis::DfareportingV2_6::CompanionClickThroughOverride>
Companion creative overrides for this creative assignment. Applicable to video
ads.
Corresponds to the JSON property companionCreativeOverrides
3592 3593 3594 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 3592 def companion_creative_overrides @companion_creative_overrides end |
#creative_group_assignments ⇒ Array<Google::Apis::DfareportingV2_6::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
3598 3599 3600 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 3598 def creative_group_assignments @creative_group_assignments end |
#creative_id ⇒ String
ID of the creative to be assigned. This is a required field.
Corresponds to the JSON property creativeId
3603 3604 3605 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 3603 def creative_id @creative_id end |
#creative_id_dimension_value ⇒ Google::Apis::DfareportingV2_6::DimensionValue
Represents a DimensionValue resource.
Corresponds to the JSON property creativeIdDimensionValue
3608 3609 3610 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 3608 def creative_id_dimension_value @creative_id_dimension_value end |
#end_time ⇒ DateTime
Date and time that the assigned creative should stop serving. Must be later
than the start time.
Corresponds to the JSON property endTime
3614 3615 3616 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 3614 def end_time @end_time end |
#rich_media_exit_overrides ⇒ Array<Google::Apis::DfareportingV2_6::RichMediaExitOverride>
Rich media exit overrides for this creative assignment. Applicable when the creative type is any of the following:
- 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
- ADVANCED_BANNER
- VPAID_LINEAR
- VPAID_NON_LINEAR
Corresponds to the JSON property
richMediaExitOverrides
3631 3632 3633 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 3631 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.
Corresponds to the JSON property sequence
3637 3638 3639 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 3637 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
3643 3644 3645 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 3643 def ssl_compliant @ssl_compliant end |
#start_time ⇒ DateTime
Date and time that the assigned creative should start serving.
Corresponds to the JSON property startTime
3649 3650 3651 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 3649 def start_time @start_time end |
#weight ⇒ Fixnum
Weight of the creative assignment, applicable when the rotation type is
CREATIVE_ROTATION_TYPE_RANDOM.
Corresponds to the JSON property weight
3655 3656 3657 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 3655 def weight @weight end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 3662 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 |