Class: Google::Apis::DfareportingV3_1::Ad

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dfareporting_v3_1/classes.rb,
generated/google/apis/dfareporting_v3_1/representations.rb,
generated/google/apis/dfareporting_v3_1/representations.rb

Overview

Contains properties of a Campaign Manager ad.

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) ⇒ Ad

Returns a new instance of Ad



874
875
876
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 874

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

Instance Attribute Details

#account_id ⇒ Fixnum

Account ID of this ad. This is a read-only field that can be left blank. Corresponds to the JSON property accountId

Returns:

  • (Fixnum) 


653
654
655
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 653

def 
  @account_id
end

#active ⇒ Boolean Also known as: active?

Whether this ad is active. When true, archived must be false. Corresponds to the JSON property active

Returns:

  • (Boolean) 


658
659
660
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 658

def active
  @active
end

#advertiser_id ⇒ Fixnum

Advertiser ID of this ad. This is a required field on insertion. Corresponds to the JSON property advertiserId

Returns:

  • (Fixnum) 


664
665
666
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 664

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV3_1::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue

Returns:



669
670
671
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 669

def advertiser_id_dimension_value
  @advertiser_id_dimension_value
end

#archived ⇒ Boolean Also known as: archived?

Whether this ad is archived. When true, active must be false. Corresponds to the JSON property archived

Returns:

  • (Boolean) 


674
675
676
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 674

def archived
  @archived
end

#audience_segment_id ⇒ Fixnum

Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD. Corresponds to the JSON property audienceSegmentId

Returns:

  • (Fixnum) 


681
682
683
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 681

def audience_segment_id
  @audience_segment_id
end

#campaign_id ⇒ Fixnum

Campaign ID of this ad. This is a required field on insertion. Corresponds to the JSON property campaignId

Returns:

  • (Fixnum) 


686
687
688
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 686

def campaign_id
  @campaign_id
end

#campaign_id_dimension_value ⇒ Google::Apis::DfareportingV3_1::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property campaignIdDimensionValue

Returns:



691
692
693
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 691

def campaign_id_dimension_value
  @campaign_id_dimension_value
end

#click_through_url ⇒ Google::Apis::DfareportingV3_1::ClickThroughUrl

Click-through URL Corresponds to the JSON property clickThroughUrl

Returns:



696
697
698
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 696

def click_through_url
  @click_through_url
end

#click_through_url_suffix_properties ⇒ Google::Apis::DfareportingV3_1::ClickThroughUrlSuffixProperties

Click Through URL Suffix settings. Corresponds to the JSON property clickThroughUrlSuffixProperties

Returns:



701
702
703
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 701

def click_through_url_suffix_properties
  @click_through_url_suffix_properties
end

#comments ⇒ String

Comments for this ad. Corresponds to the JSON property comments

Returns:

  • (String) 


706
707
708
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 706

def comments
  @comments
end

#compatibility ⇒ String

Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard. Corresponds to the JSON property compatibility

Returns:

  • (String) 


718
719
720
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 718

def compatibility
  @compatibility
end

#create_info ⇒ Google::Apis::DfareportingV3_1::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property createInfo

Returns:



723
724
725
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 723

def create_info
  @create_info
end

#creative_group_assignments ⇒ Array<Google::Apis::DfareportingV3_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

Returns:



730
731
732
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 730

def creative_group_assignments
  @creative_group_assignments
end

#creative_rotation ⇒ Google::Apis::DfareportingV3_1::CreativeRotation

Creative Rotation. Corresponds to the JSON property creativeRotation

Returns:



735
736
737
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 735

def creative_rotation
  @creative_rotation
end

#day_part_targeting ⇒ Google::Apis::DfareportingV3_1::DayPartTargeting

Day Part Targeting. Corresponds to the JSON property dayPartTargeting

Returns:



740
741
742
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 740

def day_part_targeting
  @day_part_targeting
end

#default_click_through_event_tag_properties ⇒ Google::Apis::DfareportingV3_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

Returns:



747
748
749
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 747

def default_click_through_event_tag_properties
  @default_click_through_event_tag_properties
end

#delivery_schedule ⇒ Google::Apis::DfareportingV3_1::DeliverySchedule

Delivery Schedule. Corresponds to the JSON property deliverySchedule

Returns:



752
753
754
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 752

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

Returns:

  • (Boolean) 


759
760
761
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 759

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

Returns:

  • (DateTime) 


766
767
768
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 766

def end_time
  @end_time
end

#event_tag_overrides ⇒ Array<Google::Apis::DfareportingV3_1::EventTagOverride>

Event tag overrides for this ad. Corresponds to the JSON property eventTagOverrides

Returns:



771
772
773
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 771

def event_tag_overrides
  @event_tag_overrides
end

#geo_targeting ⇒ Google::Apis::DfareportingV3_1::GeoTargeting

Geographical Targeting. Corresponds to the JSON property geoTargeting

Returns:



776
777
778
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 776

def geo_targeting
  @geo_targeting
end

#id ⇒ Fixnum

ID of this ad. This is a read-only, auto-generated field. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


781
782
783
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 781

def id
  @id
end

#id_dimension_value ⇒ Google::Apis::DfareportingV3_1::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



786
787
788
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 786

def id_dimension_value
  @id_dimension_value
end

#key_value_targeting_expression ⇒ Google::Apis::DfareportingV3_1::KeyValueTargetingExpression

Key Value Targeting Expression. Corresponds to the JSON property keyValueTargetingExpression

Returns:



791
792
793
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 791

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

Returns:

  • (String) 


797
798
799
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 797

def kind
  @kind
end

#language_targeting ⇒ Google::Apis::DfareportingV3_1::LanguageTargeting

Language Targeting. Corresponds to the JSON property languageTargeting

Returns:



802
803
804
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 802

def language_targeting
  @language_targeting
end

#last_modified_info ⇒ Google::Apis::DfareportingV3_1::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property lastModifiedInfo

Returns:



807
808
809
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 807

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

Returns:

  • (String) 


813
814
815
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 813

def name
  @name
end

#placement_assignments ⇒ Array<Google::Apis::DfareportingV3_1::PlacementAssignment>

Placement assignments for this ad. Corresponds to the JSON property placementAssignments

Returns:



818
819
820
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 818

def placement_assignments
  @placement_assignments
end

#remarketing_list_expression ⇒ Google::Apis::DfareportingV3_1::ListTargetingExpression

Remarketing List Targeting Expression. Corresponds to the JSON property remarketingListExpression

Returns:



823
824
825
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 823

def remarketing_list_expression
  @remarketing_list_expression
end

#size ⇒ Google::Apis::DfareportingV3_1::Size

Represents the dimensions of ads, placements, creatives, or creative assets. Corresponds to the JSON property size

Returns:



828
829
830
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 828

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

Returns:

  • (Boolean) 


834
835
836
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 834

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

Returns:

  • (Boolean) 


841
842
843
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 841

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

Returns:

  • (DateTime) 


848
849
850
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 848

def start_time
  @start_time
end

#subaccount_id ⇒ Fixnum

Subaccount ID of this ad. This is a read-only field that can be left blank. Corresponds to the JSON property subaccountId

Returns:

  • (Fixnum) 


853
854
855
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 853

def subaccount_id
  @subaccount_id
end

#targeting_template_id ⇒ Fixnum

Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD. Corresponds to the JSON property targetingTemplateId

Returns:

  • (Fixnum) 


861
862
863
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 861

def targeting_template_id
  @targeting_template_id
end

#technology_targeting ⇒ Google::Apis::DfareportingV3_1::TechnologyTargeting

Technology Targeting. Corresponds to the JSON property technologyTargeting

Returns:



866
867
868
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 866

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

Returns:

  • (String) 


872
873
874
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 872

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 879

def update!(**args)
  @account_id = args[:account_id] if args.key?(:account_id)
  @active = args[:active] if args.key?(:active)
  @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id)
  @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value)
  @archived = args[:archived] if args.key?(:archived)
  @audience_segment_id = args[:audience_segment_id] if args.key?(:audience_segment_id)
  @campaign_id = args[:campaign_id] if args.key?(:campaign_id)
  @campaign_id_dimension_value = args[:campaign_id_dimension_value] if args.key?(:campaign_id_dimension_value)
  @click_through_url = args[:click_through_url] if args.key?(:click_through_url)
  @click_through_url_suffix_properties = args[:click_through_url_suffix_properties] if args.key?(:click_through_url_suffix_properties)
  @comments = args[:comments] if args.key?(:comments)
  @compatibility = args[:compatibility] if args.key?(:compatibility)
  @create_info = args[:create_info] if args.key?(:create_info)
  @creative_group_assignments = args[:creative_group_assignments] if args.key?(:creative_group_assignments)
  @creative_rotation = args[:creative_rotation] if args.key?(:creative_rotation)
  @day_part_targeting = args[:day_part_targeting] if args.key?(:day_part_targeting)
  @default_click_through_event_tag_properties = args[:default_click_through_event_tag_properties] if args.key?(:default_click_through_event_tag_properties)
  @delivery_schedule = args[:delivery_schedule] if args.key?(:delivery_schedule)
  @dynamic_click_tracker = args[:dynamic_click_tracker] if args.key?(:dynamic_click_tracker)
  @end_time = args[:end_time] if args.key?(:end_time)
  @event_tag_overrides = args[:event_tag_overrides] if args.key?(:event_tag_overrides)
  @geo_targeting = args[:geo_targeting] if args.key?(:geo_targeting)
  @id = args[:id] if args.key?(:id)
  @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value)
  @key_value_targeting_expression = args[:key_value_targeting_expression] if args.key?(:key_value_targeting_expression)
  @kind = args[:kind] if args.key?(:kind)
  @language_targeting = args[:language_targeting] if args.key?(:language_targeting)
  @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info)
  @name = args[:name] if args.key?(:name)
  @placement_assignments = args[:placement_assignments] if args.key?(:placement_assignments)
  @remarketing_list_expression = args[:remarketing_list_expression] if args.key?(:remarketing_list_expression)
  @size = args[:size] if args.key?(:size)
  @ssl_compliant = args[:ssl_compliant] if args.key?(:ssl_compliant)
  @ssl_required = args[:ssl_required] if args.key?(:ssl_required)
  @start_time = args[:start_time] if args.key?(:start_time)
  @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id)
  @targeting_template_id = args[:targeting_template_id] if args.key?(:targeting_template_id)
  @technology_targeting = args[:technology_targeting] if args.key?(:technology_targeting)
  @type = args[:type] if args.key?(:type)
end