Class: Google::Apis::DfareportingV2_6::Ad

Inherits:
Object
  • Object
show all
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

Contains properties of a DCM 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.


871
872
873
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 871

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

Instance Attribute Details

#account_idString

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

Returns:

  • (String)

650
651
652
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 650

def 
  @account_id
end

#activeBoolean Also known as: active?

Whether this ad is active. Corresponds to the JSON property active

Returns:

  • (Boolean)

655
656
657
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 655

def active
  @active
end

#advertiser_idString

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

Returns:

  • (String)

661
662
663
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 661

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_valueGoogle::Apis::DfareportingV2_6::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue


666
667
668
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 666

def advertiser_id_dimension_value
  @advertiser_id_dimension_value
end

#archivedBoolean Also known as: archived?

Whether this ad is archived. Corresponds to the JSON property archived

Returns:

  • (Boolean)

671
672
673
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 671

def archived
  @archived
end

#audience_segment_idString

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:

  • (String)

678
679
680
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 678

def audience_segment_id
  @audience_segment_id
end

#campaign_idString

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

Returns:

  • (String)

683
684
685
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 683

def campaign_id
  @campaign_id
end

#campaign_id_dimension_valueGoogle::Apis::DfareportingV2_6::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property campaignIdDimensionValue


688
689
690
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 688

def campaign_id_dimension_value
  @campaign_id_dimension_value
end

#click_through_urlGoogle::Apis::DfareportingV2_6::ClickThroughUrl

Click-through URL Corresponds to the JSON property clickThroughUrl


693
694
695
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 693

def click_through_url
  @click_through_url
end

#click_through_url_suffix_propertiesGoogle::Apis::DfareportingV2_6::ClickThroughUrlSuffixProperties

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


698
699
700
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 698

def click_through_url_suffix_properties
  @click_through_url_suffix_properties
end

#commentsString

Comments for this ad. Corresponds to the JSON property comments

Returns:

  • (String)

703
704
705
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 703

def comments
  @comments
end

#compatibilityString

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)

715
716
717
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 715

def compatibility
  @compatibility
end

#create_infoGoogle::Apis::DfareportingV2_6::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property createInfo


720
721
722
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 720

def create_info
  @create_info
end

#creative_group_assignmentsArray<Google::Apis::DfareportingV2_6::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


727
728
729
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 727

def creative_group_assignments
  @creative_group_assignments
end

#creative_rotationGoogle::Apis::DfareportingV2_6::CreativeRotation

Creative Rotation. Corresponds to the JSON property creativeRotation


732
733
734
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 732

def creative_rotation
  @creative_rotation
end

#day_part_targetingGoogle::Apis::DfareportingV2_6::DayPartTargeting

Day Part Targeting. Corresponds to the JSON property dayPartTargeting


737
738
739
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 737

def day_part_targeting
  @day_part_targeting
end

#default_click_through_event_tag_propertiesGoogle::Apis::DfareportingV2_6::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


744
745
746
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 744

def default_click_through_event_tag_properties
  @default_click_through_event_tag_properties
end

#delivery_scheduleGoogle::Apis::DfareportingV2_6::DeliverySchedule

Delivery Schedule. Corresponds to the JSON property deliverySchedule


749
750
751
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 749

def delivery_schedule
  @delivery_schedule
end

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

756
757
758
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 756

def dynamic_click_tracker
  @dynamic_click_tracker
end

#end_timeDateTime

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)

763
764
765
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 763

def end_time
  @end_time
end

#event_tag_overridesArray<Google::Apis::DfareportingV2_6::EventTagOverride>

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


768
769
770
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 768

def event_tag_overrides
  @event_tag_overrides
end

#geo_targetingGoogle::Apis::DfareportingV2_6::GeoTargeting

Geographical Targeting. Corresponds to the JSON property geoTargeting


773
774
775
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 773

def geo_targeting
  @geo_targeting
end

#idString

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

Returns:

  • (String)

778
779
780
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 778

def id
  @id
end

#id_dimension_valueGoogle::Apis::DfareportingV2_6::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue


783
784
785
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 783

def id_dimension_value
  @id_dimension_value
end

#key_value_targeting_expressionGoogle::Apis::DfareportingV2_6::KeyValueTargetingExpression

Key Value Targeting Expression. Corresponds to the JSON property keyValueTargetingExpression


788
789
790
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 788

def key_value_targeting_expression
  @key_value_targeting_expression
end

#kindString

Identifies what kind of resource this is. Value: the fixed string " dfareporting#ad". Corresponds to the JSON property kind

Returns:

  • (String)

794
795
796
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 794

def kind
  @kind
end

#language_targetingGoogle::Apis::DfareportingV2_6::LanguageTargeting

Language Targeting. Corresponds to the JSON property languageTargeting


799
800
801
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 799

def language_targeting
  @language_targeting
end

#last_modified_infoGoogle::Apis::DfareportingV2_6::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property lastModifiedInfo


804
805
806
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 804

def last_modified_info
  @last_modified_info
end

#nameString

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)

810
811
812
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 810

def name
  @name
end

#placement_assignmentsArray<Google::Apis::DfareportingV2_6::PlacementAssignment>

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


815
816
817
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 815

def placement_assignments
  @placement_assignments
end

#remarketing_list_expressionGoogle::Apis::DfareportingV2_6::ListTargetingExpression

Remarketing List Targeting Expression. Corresponds to the JSON property remarketingListExpression


820
821
822
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 820

def remarketing_list_expression
  @remarketing_list_expression
end

#sizeGoogle::Apis::DfareportingV2_6::Size

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


825
826
827
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 825

def size
  @size
end

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

831
832
833
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 831

def ssl_compliant
  @ssl_compliant
end

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

838
839
840
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 838

def ssl_required
  @ssl_required
end

#start_timeDateTime

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)

845
846
847
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 845

def start_time
  @start_time
end

#subaccount_idString

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

Returns:

  • (String)

850
851
852
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 850

def subaccount_id
  @subaccount_id
end

#targeting_template_idString

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:

  • (String)

858
859
860
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 858

def targeting_template_id
  @targeting_template_id
end

#technology_targetingGoogle::Apis::DfareportingV2_6::TechnologyTargeting

Technology Targeting. Corresponds to the JSON property technologyTargeting


863
864
865
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 863

def technology_targeting
  @technology_targeting
end

#typeString

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)

869
870
871
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 869

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


876
877
878
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
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 876

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