Class: Google::Apis::DfareportingV3_3::CreativeAssignment
- Inherits:
-
Object
- Object
- Google::Apis::DfareportingV3_3::CreativeAssignment
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/dfareporting_v3_3/classes.rb,
generated/google/apis/dfareporting_v3_3/representations.rb,
generated/google/apis/dfareporting_v3_3/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::DfareportingV3_3::ClickThroughUrl
Click-through URL Corresponds to the JSON property
clickThroughUrl
. -
#companion_creative_overrides ⇒ Array<Google::Apis::DfareportingV3_3::CompanionClickThroughOverride>
Companion creative overrides for this creative assignment.
-
#creative_group_assignments ⇒ Array<Google::Apis::DfareportingV3_3::CreativeGroupAssignment>
Creative group assignments for this creative assignment.
-
#creative_id ⇒ Fixnum
ID of the creative to be assigned.
-
#creative_id_dimension_value ⇒ Google::Apis::DfareportingV3_3::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::DfareportingV3_3::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.
3976 3977 3978 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3976 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
3889 3890 3891 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3889 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
3898 3899 3900 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3898 def @apply_event_tags end |
#click_through_url ⇒ Google::Apis::DfareportingV3_3::ClickThroughUrl
Click-through URL
Corresponds to the JSON property clickThroughUrl
3904 3905 3906 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3904 def click_through_url @click_through_url end |
#companion_creative_overrides ⇒ Array<Google::Apis::DfareportingV3_3::CompanionClickThroughOverride>
Companion creative overrides for this creative assignment. Applicable to video
ads.
Corresponds to the JSON property companionCreativeOverrides
3910 3911 3912 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3910 def companion_creative_overrides @companion_creative_overrides end |
#creative_group_assignments ⇒ Array<Google::Apis::DfareportingV3_3::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
3916 3917 3918 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3916 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
3921 3922 3923 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3921 def creative_id @creative_id end |
#creative_id_dimension_value ⇒ Google::Apis::DfareportingV3_3::DimensionValue
Represents a DimensionValue resource.
Corresponds to the JSON property creativeIdDimensionValue
3926 3927 3928 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3926 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
3932 3933 3934 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3932 def end_time @end_time end |
#rich_media_exit_overrides ⇒ Array<Google::Apis::DfareportingV3_3::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
3949 3950 3951 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3949 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
3956 3957 3958 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3956 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
3962 3963 3964 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3962 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
3968 3969 3970 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3968 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
3974 3975 3976 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3974 def weight @weight end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3981 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 |