Class: Google::Apis::DfareportingV2_1::Ad
- Inherits:
-
Object
- Object
- Google::Apis::DfareportingV2_1::Ad
- Includes:
- Core::Hashable
- Defined in:
- generated/google/apis/dfareporting_v2_1/classes.rb,
generated/google/apis/dfareporting_v2_1/representations.rb,
generated/google/apis/dfareporting_v2_1/representations.rb
Overview
Contains properties of a DCM ad.
Instance Attribute Summary collapse
-
#account_id ⇒ String
Account ID of this ad.
-
#active ⇒ Boolean
(also: #active?)
Whether this ad is active.
-
#advertiser_id ⇒ String
Advertiser ID of this ad.
-
#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV2_1::DimensionValue
Represents a DimensionValue resource.
-
#archived ⇒ Boolean
(also: #archived?)
Whether this ad is archived.
-
#audience_segment_id ⇒ String
Audience segment ID that is being targeted for this ad.
-
#campaign_id ⇒ String
Campaign ID of this ad.
-
#campaign_id_dimension_value ⇒ Google::Apis::DfareportingV2_1::DimensionValue
Represents a DimensionValue resource.
-
#click_through_url ⇒ Google::Apis::DfareportingV2_1::ClickThroughUrl
Click-through URL Corresponds to the JSON property
clickThroughUrl
. -
#click_through_url_suffix_properties ⇒ Google::Apis::DfareportingV2_1::ClickThroughUrlSuffixProperties
Click Through URL Suffix settings.
-
#comments ⇒ String
Comments for this ad.
-
#compatibility ⇒ String
Compatibility of this ad.
-
#create_info ⇒ Google::Apis::DfareportingV2_1::LastModifiedInfo
Modification timestamp.
-
#creative_group_assignments ⇒ Array<Google::Apis::DfareportingV2_1::CreativeGroupAssignment>
Creative group assignments for this ad.
-
#creative_rotation ⇒ Google::Apis::DfareportingV2_1::CreativeRotation
Creative Rotation.
-
#day_part_targeting ⇒ Google::Apis::DfareportingV2_1::DayPartTargeting
Day Part Targeting.
-
#default_click_through_event_tag_properties ⇒ Google::Apis::DfareportingV2_1::DefaultClickThroughEventTagProperties
Properties of inheriting and overriding the default click-through event tag.
-
#delivery_schedule ⇒ Google::Apis::DfareportingV2_1::DeliverySchedule
Delivery Schedule.
-
#dynamic_click_tracker ⇒ Boolean
(also: #dynamic_click_tracker?)
Whether this ad is a dynamic click tracker.
-
#end_time ⇒ DateTime
Date and time that this ad should stop serving.
-
#event_tag_overrides ⇒ Array<Google::Apis::DfareportingV2_1::EventTagOverride>
Event tag overrides for this ad.
-
#geo_targeting ⇒ Google::Apis::DfareportingV2_1::GeoTargeting
Geographical Targeting.
-
#id ⇒ String
ID of this ad.
-
#id_dimension_value ⇒ Google::Apis::DfareportingV2_1::DimensionValue
Represents a DimensionValue resource.
-
#key_value_targeting_expression ⇒ Google::Apis::DfareportingV2_1::KeyValueTargetingExpression
Key Value Targeting Expression.
-
#kind ⇒ String
Identifies what kind of resource this is.
-
#last_modified_info ⇒ Google::Apis::DfareportingV2_1::LastModifiedInfo
Modification timestamp.
-
#name ⇒ String
Name of this ad.
-
#placement_assignments ⇒ Array<Google::Apis::DfareportingV2_1::PlacementAssignment>
Placement assignments for this ad.
-
#remarketing_list_expression ⇒ Google::Apis::DfareportingV2_1::ListTargetingExpression
Remarketing List Targeting Expression.
-
#size ⇒ Google::Apis::DfareportingV2_1::Size
Represents the dimensions of ads, placements, creatives, or creative assets.
-
#ssl_compliant ⇒ Boolean
(also: #ssl_compliant?)
Whether this ad is ssl compliant.
-
#ssl_required ⇒ Boolean
(also: #ssl_required?)
Whether this ad requires ssl.
-
#start_time ⇒ DateTime
Date and time that this ad should start serving.
-
#subaccount_id ⇒ String
Subaccount ID of this ad.
-
#technology_targeting ⇒ Google::Apis::DfareportingV2_1::TechnologyTargeting
Technology Targeting.
-
#type ⇒ String
Type of ad.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Ad
constructor
A new instance of Ad.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Ad
Returns a new instance of Ad.
848 849 850 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 848 def initialize(**args) update!(**args) end |
Instance Attribute Details
#account_id ⇒ String
Account ID of this ad. This is a read-only field that can be left blank.
Corresponds to the JSON property accountId
643 644 645 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 643 def account_id @account_id end |
#active ⇒ Boolean Also known as: active?
Whether this ad is active.
Corresponds to the JSON property active
648 649 650 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 648 def active @active end |
#advertiser_id ⇒ String
Advertiser ID of this ad. This is a required field on insertion.
Corresponds to the JSON property advertiserId
654 655 656 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 654 def advertiser_id @advertiser_id end |
#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV2_1::DimensionValue
Represents a DimensionValue resource.
Corresponds to the JSON property advertiserIdDimensionValue
659 660 661 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 659 def advertiser_id_dimension_value @advertiser_id_dimension_value end |
#archived ⇒ Boolean Also known as: archived?
Whether this ad is archived.
Corresponds to the JSON property archived
664 665 666 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 664 def archived @archived end |
#audience_segment_id ⇒ String
Audience segment ID that is being targeted for this ad. Applicable when type
is AD_SERVING_STANDARD_AD.
Corresponds to the JSON property audienceSegmentId
671 672 673 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 671 def audience_segment_id @audience_segment_id end |
#campaign_id ⇒ String
Campaign ID of this ad. This is a required field on insertion.
Corresponds to the JSON property campaignId
676 677 678 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 676 def campaign_id @campaign_id end |
#campaign_id_dimension_value ⇒ Google::Apis::DfareportingV2_1::DimensionValue
Represents a DimensionValue resource.
Corresponds to the JSON property campaignIdDimensionValue
681 682 683 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 681 def campaign_id_dimension_value @campaign_id_dimension_value end |
#click_through_url ⇒ Google::Apis::DfareportingV2_1::ClickThroughUrl
Click-through URL
Corresponds to the JSON property clickThroughUrl
686 687 688 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 686 def click_through_url @click_through_url end |
#click_through_url_suffix_properties ⇒ Google::Apis::DfareportingV2_1::ClickThroughUrlSuffixProperties
Click Through URL Suffix settings.
Corresponds to the JSON property clickThroughUrlSuffixProperties
691 692 693 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 691 def click_through_url_suffix_properties @click_through_url_suffix_properties end |
#comments ⇒ String
Comments for this ad.
Corresponds to the JSON property comments
696 697 698 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 696 def comments @comments end |
#compatibility ⇒ String
Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. WEB
and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices
for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are
for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream
video ads developed with the VAST standard.
Corresponds to the JSON property compatibility
705 706 707 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 705 def compatibility @compatibility end |
#create_info ⇒ Google::Apis::DfareportingV2_1::LastModifiedInfo
Modification timestamp.
Corresponds to the JSON property createInfo
710 711 712 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 710 def create_info @create_info end |
#creative_group_assignments ⇒ Array<Google::Apis::DfareportingV2_1::CreativeGroupAssignment>
Creative group assignments for this ad. Applicable when type is
AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is
allowed for a maximum of two assignments.
Corresponds to the JSON property creativeGroupAssignments
717 718 719 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 717 def creative_group_assignments @creative_group_assignments end |
#creative_rotation ⇒ Google::Apis::DfareportingV2_1::CreativeRotation
Creative Rotation.
Corresponds to the JSON property creativeRotation
722 723 724 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 722 def creative_rotation @creative_rotation end |
#day_part_targeting ⇒ Google::Apis::DfareportingV2_1::DayPartTargeting
Day Part Targeting.
Corresponds to the JSON property dayPartTargeting
727 728 729 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 727 def day_part_targeting @day_part_targeting end |
#default_click_through_event_tag_properties ⇒ Google::Apis::DfareportingV2_1::DefaultClickThroughEventTagProperties
Properties of inheriting and overriding the default click-through event tag. A
campaign may override the event tag defined at the advertiser level, and an ad
may also override the campaign's setting further.
Corresponds to the JSON property defaultClickThroughEventTagProperties
734 735 736 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 734 def default_click_through_event_tag_properties @default_click_through_event_tag_properties end |
#delivery_schedule ⇒ Google::Apis::DfareportingV2_1::DeliverySchedule
Delivery Schedule.
Corresponds to the JSON property deliverySchedule
739 740 741 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 739 def delivery_schedule @delivery_schedule end |
#dynamic_click_tracker ⇒ Boolean Also known as: dynamic_click_tracker?
Whether this ad is a dynamic click tracker. Applicable when type is
AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only
after insert.
Corresponds to the JSON property dynamicClickTracker
746 747 748 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 746 def dynamic_click_tracker @dynamic_click_tracker end |
#end_time ⇒ DateTime
Date and time that this ad should stop serving. Must be later than the start
time. This is a required field on insertion.
Corresponds to the JSON property endTime
753 754 755 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 753 def end_time @end_time end |
#event_tag_overrides ⇒ Array<Google::Apis::DfareportingV2_1::EventTagOverride>
Event tag overrides for this ad.
Corresponds to the JSON property eventTagOverrides
758 759 760 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 758 def event_tag_overrides @event_tag_overrides end |
#geo_targeting ⇒ Google::Apis::DfareportingV2_1::GeoTargeting
Geographical Targeting.
Corresponds to the JSON property geoTargeting
763 764 765 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 763 def geo_targeting @geo_targeting end |
#id ⇒ String
ID of this ad. This is a read-only, auto-generated field.
Corresponds to the JSON property id
768 769 770 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 768 def id @id end |
#id_dimension_value ⇒ Google::Apis::DfareportingV2_1::DimensionValue
Represents a DimensionValue resource.
Corresponds to the JSON property idDimensionValue
773 774 775 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 773 def id_dimension_value @id_dimension_value end |
#key_value_targeting_expression ⇒ Google::Apis::DfareportingV2_1::KeyValueTargetingExpression
Key Value Targeting Expression.
Corresponds to the JSON property keyValueTargetingExpression
778 779 780 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 778 def key_value_targeting_expression @key_value_targeting_expression end |
#kind ⇒ String
Identifies what kind of resource this is. Value: the fixed string "
dfareporting#ad".
Corresponds to the JSON property kind
784 785 786 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 784 def kind @kind end |
#last_modified_info ⇒ Google::Apis::DfareportingV2_1::LastModifiedInfo
Modification timestamp.
Corresponds to the JSON property lastModifiedInfo
789 790 791 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 789 def last_modified_info @last_modified_info end |
#name ⇒ String
Name of this ad. This is a required field and must be less than 256 characters
long.
Corresponds to the JSON property name
795 796 797 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 795 def name @name end |
#placement_assignments ⇒ Array<Google::Apis::DfareportingV2_1::PlacementAssignment>
Placement assignments for this ad.
Corresponds to the JSON property placementAssignments
800 801 802 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 800 def placement_assignments @placement_assignments end |
#remarketing_list_expression ⇒ Google::Apis::DfareportingV2_1::ListTargetingExpression
Remarketing List Targeting Expression.
Corresponds to the JSON property remarketing_list_expression
805 806 807 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 805 def remarketing_list_expression @remarketing_list_expression end |
#size ⇒ Google::Apis::DfareportingV2_1::Size
Represents the dimensions of ads, placements, creatives, or creative assets.
Corresponds to the JSON property size
810 811 812 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 810 def size @size end |
#ssl_compliant ⇒ Boolean Also known as: ssl_compliant?
Whether this ad 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
816 817 818 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 816 def ssl_compliant @ssl_compliant end |
#ssl_required ⇒ Boolean Also known as: ssl_required?
Whether this ad requires ssl. This is a read-only field that is auto-generated
when the ad is inserted or updated.
Corresponds to the JSON property sslRequired
823 824 825 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 823 def ssl_required @ssl_required end |
#start_time ⇒ DateTime
Date and time that this ad should start serving. If creating an ad, this field
must be a time in the future. This is a required field on insertion.
Corresponds to the JSON property startTime
830 831 832 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 830 def start_time @start_time end |
#subaccount_id ⇒ String
Subaccount ID of this ad. This is a read-only field that can be left blank.
Corresponds to the JSON property subaccountId
835 836 837 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 835 def subaccount_id @subaccount_id end |
#technology_targeting ⇒ Google::Apis::DfareportingV2_1::TechnologyTargeting
Technology Targeting.
Corresponds to the JSON property technologyTargeting
840 841 842 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 840 def technology_targeting @technology_targeting end |
#type ⇒ String
Type of ad. This is a required field on insertion. Note that default ads (
AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
Corresponds to the JSON property type
846 847 848 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 846 def type @type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 853 def update!(**args) @account_id = args[:account_id] unless args[:account_id].nil? @active = args[:active] unless args[:active].nil? @advertiser_id = args[:advertiser_id] unless args[:advertiser_id].nil? @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] unless args[:advertiser_id_dimension_value].nil? @archived = args[:archived] unless args[:archived].nil? @audience_segment_id = args[:audience_segment_id] unless args[:audience_segment_id].nil? @campaign_id = args[:campaign_id] unless args[:campaign_id].nil? @campaign_id_dimension_value = args[:campaign_id_dimension_value] unless args[:campaign_id_dimension_value].nil? @click_through_url = args[:click_through_url] unless args[:click_through_url].nil? @click_through_url_suffix_properties = args[:click_through_url_suffix_properties] unless args[:click_through_url_suffix_properties].nil? @comments = args[:comments] unless args[:comments].nil? @compatibility = args[:compatibility] unless args[:compatibility].nil? @create_info = args[:create_info] unless args[:create_info].nil? @creative_group_assignments = args[:creative_group_assignments] unless args[:creative_group_assignments].nil? @creative_rotation = args[:creative_rotation] unless args[:creative_rotation].nil? @day_part_targeting = args[:day_part_targeting] unless args[:day_part_targeting].nil? @default_click_through_event_tag_properties = args[:default_click_through_event_tag_properties] unless args[:default_click_through_event_tag_properties].nil? @delivery_schedule = args[:delivery_schedule] unless args[:delivery_schedule].nil? @dynamic_click_tracker = args[:dynamic_click_tracker] unless args[:dynamic_click_tracker].nil? @end_time = args[:end_time] unless args[:end_time].nil? @event_tag_overrides = args[:event_tag_overrides] unless args[:event_tag_overrides].nil? @geo_targeting = args[:geo_targeting] unless args[:geo_targeting].nil? @id = args[:id] unless args[:id].nil? @id_dimension_value = args[:id_dimension_value] unless args[:id_dimension_value].nil? @key_value_targeting_expression = args[:key_value_targeting_expression] unless args[:key_value_targeting_expression].nil? @kind = args[:kind] unless args[:kind].nil? @last_modified_info = args[:last_modified_info] unless args[:last_modified_info].nil? @name = args[:name] unless args[:name].nil? @placement_assignments = args[:placement_assignments] unless args[:placement_assignments].nil? @remarketing_list_expression = args[:remarketing_list_expression] unless args[:remarketing_list_expression].nil? @size = args[:size] unless args[:size].nil? @ssl_compliant = args[:ssl_compliant] unless args[:ssl_compliant].nil? @ssl_required = args[:ssl_required] unless args[:ssl_required].nil? @start_time = args[:start_time] unless args[:start_time].nil? @subaccount_id = args[:subaccount_id] unless args[:subaccount_id].nil? @technology_targeting = args[:technology_targeting] unless args[:technology_targeting].nil? @type = args[:type] unless args[:type].nil? end |