Class: Google::Apis::DfareportingV4::Campaign

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

Overview

Contains properties of a Campaign Manager campaign.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Campaign

Returns a new instance of Campaign.



1918
1919
1920
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1918

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

Instance Attribute Details

#account_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


1778
1779
1780
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1778

def 
  @account_id
end

#ad_blocking_configuration ⇒ Google::Apis::DfareportingV4::AdBlockingConfiguration

Campaign ad blocking settings. Corresponds to the JSON property adBlockingConfiguration

Returns:



1783
1784
1785
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1783

def ad_blocking_configuration
  @ad_blocking_configuration
end

#additional_creative_optimization_configurations ⇒ Array<Google::Apis::DfareportingV4::CreativeOptimizationConfiguration>

Additional creative optimization configurations for the campaign. Corresponds to the JSON property additionalCreativeOptimizationConfigurations

Returns:



1788
1789
1790
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1788

def additional_creative_optimization_configurations
  @additional_creative_optimization_configurations
end

#advertiser_group_id ⇒ Fixnum

Advertiser group ID of the associated advertiser. Corresponds to the JSON property advertiserGroupId

Returns:

  • (Fixnum) 


1793
1794
1795
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1793

def advertiser_group_id
  @advertiser_group_id
end

#advertiser_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


1798
1799
1800
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1798

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV4::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue

Returns:



1803
1804
1805
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1803

def advertiser_id_dimension_value
  @advertiser_id_dimension_value
end

#archived ⇒ Boolean Also known as: archived?

Whether this campaign has been archived. Corresponds to the JSON property archived

Returns:

  • (Boolean) 


1808
1809
1810
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1808

def archived
  @archived
end

#audience_segment_groups ⇒ Array<Google::Apis::DfareportingV4::AudienceSegmentGroup>

Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups. Corresponds to the JSON property audienceSegmentGroups

Returns:



1815
1816
1817
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1815

def audience_segment_groups
  @audience_segment_groups
end

#billing_invoice_code ⇒ String

Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign. Corresponds to the JSON property billingInvoiceCode

Returns:

  • (String) 


1821
1822
1823
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1821

def billing_invoice_code
  @billing_invoice_code
end

#click_through_url_suffix_properties ⇒ Google::Apis::DfareportingV4::ClickThroughUrlSuffixProperties

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

Returns:



1826
1827
1828
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1826

def click_through_url_suffix_properties
  @click_through_url_suffix_properties
end

#comment ⇒ String

Arbitrary comments about this campaign. Must be less than 256 characters long. Corresponds to the JSON property comment

Returns:

  • (String) 


1831
1832
1833
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1831

def comment
  @comment
end

#create_info ⇒ Google::Apis::DfareportingV4::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property createInfo

Returns:



1836
1837
1838
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1836

def create_info
  @create_info
end

#creative_group_ids ⇒ Array<Fixnum>

List of creative group IDs that are assigned to the campaign. Corresponds to the JSON property creativeGroupIds

Returns:

  • (Array<Fixnum>) 


1841
1842
1843
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1841

def creative_group_ids
  @creative_group_ids
end

#creative_optimization_configuration ⇒ Google::Apis::DfareportingV4::CreativeOptimizationConfiguration

Creative optimization settings. Corresponds to the JSON property creativeOptimizationConfiguration

Returns:



1846
1847
1848
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1846

def creative_optimization_configuration
  @creative_optimization_configuration
end

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



1853
1854
1855
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1853

def default_click_through_event_tag_properties
  @default_click_through_event_tag_properties
end

#default_landing_page_id ⇒ Fixnum

The default landing page ID for this campaign. Corresponds to the JSON property defaultLandingPageId

Returns:

  • (Fixnum) 


1858
1859
1860
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1858

def default_landing_page_id
  @default_landing_page_id
end

#end_date ⇒ Date

Corresponds to the JSON property endDate

Returns:

  • (Date) 


1863
1864
1865
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1863

def end_date
  @end_date
end

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

Overrides that can be used to activate or deactivate advertiser event tags. Corresponds to the JSON property eventTagOverrides

Returns:



1868
1869
1870
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1868

def event_tag_overrides
  @event_tag_overrides
end

#external_id ⇒ String

External ID for this campaign. Corresponds to the JSON property externalId

Returns:

  • (String) 


1873
1874
1875
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1873

def external_id
  @external_id
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


1878
1879
1880
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1878

def id
  @id
end

#id_dimension_value ⇒ Google::Apis::DfareportingV4::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



1883
1884
1885
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1883

def id_dimension_value
  @id_dimension_value
end

#kind ⇒ String

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

Returns:

  • (String) 


1889
1890
1891
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1889

def kind
  @kind
end

#last_modified_info ⇒ Google::Apis::DfareportingV4::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property lastModifiedInfo

Returns:



1894
1895
1896
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1894

def last_modified_info
  @last_modified_info
end

#measurement_partner_link ⇒ Google::Apis::DfareportingV4::MeasurementPartnerCampaignLink

Measurement partner campaign link for tag wrapping. Corresponds to the JSON property measurementPartnerLink

Returns:



1899
1900
1901
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1899

def measurement_partner_link
  @measurement_partner_link
end

#name ⇒ String

Name of this campaign. This is a required field and must be less than 512 characters long and unique among campaigns of the same advertiser. Corresponds to the JSON property name

Returns:

  • (String) 


1905
1906
1907
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1905

def name
  @name
end

#start_date ⇒ Date

Corresponds to the JSON property startDate

Returns:

  • (Date) 


1910
1911
1912
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1910

def start_date
  @start_date
end

#subaccount_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


1916
1917
1918
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1916

def subaccount_id
  @subaccount_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1923

def update!(**args)
  @account_id = args[:account_id] if args.key?(:account_id)
  @ad_blocking_configuration = args[:ad_blocking_configuration] if args.key?(:ad_blocking_configuration)
  @additional_creative_optimization_configurations = args[:additional_creative_optimization_configurations] if args.key?(:additional_creative_optimization_configurations)
  @advertiser_group_id = args[:advertiser_group_id] if args.key?(:advertiser_group_id)
  @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_groups = args[:audience_segment_groups] if args.key?(:audience_segment_groups)
  @billing_invoice_code = args[:billing_invoice_code] if args.key?(:billing_invoice_code)
  @click_through_url_suffix_properties = args[:click_through_url_suffix_properties] if args.key?(:click_through_url_suffix_properties)
  @comment = args[:comment] if args.key?(:comment)
  @create_info = args[:create_info] if args.key?(:create_info)
  @creative_group_ids = args[:creative_group_ids] if args.key?(:creative_group_ids)
  @creative_optimization_configuration = args[:creative_optimization_configuration] if args.key?(:creative_optimization_configuration)
  @default_click_through_event_tag_properties = args[:default_click_through_event_tag_properties] if args.key?(:default_click_through_event_tag_properties)
  @default_landing_page_id = args[:default_landing_page_id] if args.key?(:default_landing_page_id)
  @end_date = args[:end_date] if args.key?(:end_date)
  @event_tag_overrides = args[:event_tag_overrides] if args.key?(:event_tag_overrides)
  @external_id = args[:external_id] if args.key?(:external_id)
  @id = args[:id] if args.key?(:id)
  @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value)
  @kind = args[:kind] if args.key?(:kind)
  @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info)
  @measurement_partner_link = args[:measurement_partner_link] if args.key?(:measurement_partner_link)
  @name = args[:name] if args.key?(:name)
  @start_date = args[:start_date] if args.key?(:start_date)
  @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id)
end