Class: Google::Apis::DfareportingV3_4::PlacementGroup

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

Overview

Contains properties of a package or roadblock.

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

Returns a new instance of PlacementGroup.



9007
9008
9009
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 9007

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

Instance Attribute Details

#account_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8862
8863
8864
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8862

def 
  @account_id
end

#advertiser_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8867
8868
8869
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8867

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV3_4::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue

Returns:



8872
8873
8874
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8872

def advertiser_id_dimension_value
  @advertiser_id_dimension_value
end

#archived ⇒ Boolean Also known as: archived?

Whether this placement group is archived. Corresponds to the JSON property archived

Returns:

  • (Boolean) 


8877
8878
8879
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8877

def archived
  @archived
end

#campaign_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8883
8884
8885
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8883

def campaign_id
  @campaign_id
end

#campaign_id_dimension_value ⇒ Google::Apis::DfareportingV3_4::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property campaignIdDimensionValue

Returns:



8888
8889
8890
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8888

def campaign_id_dimension_value
  @campaign_id_dimension_value
end

#child_placement_ids ⇒ Array<Fixnum>

IDs of placements which are assigned to this placement group. This is a read- only, auto-generated field. Corresponds to the JSON property childPlacementIds

Returns:

  • (Array<Fixnum>) 


8894
8895
8896
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8894

def child_placement_ids
  @child_placement_ids
end

#comment ⇒ String

Comments for this placement group. Corresponds to the JSON property comment

Returns:

  • (String) 


8899
8900
8901
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8899

def comment
  @comment
end

#content_category_id ⇒ Fixnum

ID of the content category assigned to this placement group. Corresponds to the JSON property contentCategoryId

Returns:

  • (Fixnum) 


8904
8905
8906
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8904

def content_category_id
  @content_category_id
end

#create_info ⇒ Google::Apis::DfareportingV3_4::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property createInfo

Returns:



8909
8910
8911
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8909

def create_info
  @create_info
end

#directory_site_id ⇒ Fixnum

Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion. Corresponds to the JSON property directorySiteId

Returns:

  • (Fixnum) 


8917
8918
8919
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8917

def directory_site_id
  @directory_site_id
end

#directory_site_id_dimension_value ⇒ Google::Apis::DfareportingV3_4::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property directorySiteIdDimensionValue

Returns:



8922
8923
8924
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8922

def directory_site_id_dimension_value
  @directory_site_id_dimension_value
end

#external_id ⇒ String

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

Returns:

  • (String) 


8927
8928
8929
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8927

def external_id
  @external_id
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8932
8933
8934
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8932

def id
  @id
end

#id_dimension_value ⇒ Google::Apis::DfareportingV3_4::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



8937
8938
8939
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8937

def id_dimension_value
  @id_dimension_value
end

#kind ⇒ String

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

Returns:

  • (String) 


8943
8944
8945
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8943

def kind
  @kind
end

#last_modified_info ⇒ Google::Apis::DfareportingV3_4::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property lastModifiedInfo

Returns:



8948
8949
8950
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8948

def last_modified_info
  @last_modified_info
end

#name ⇒ String

Name of this placement group. This is a required field and must be less than 256 characters long. Corresponds to the JSON property name

Returns:

  • (String) 


8954
8955
8956
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8954

def name
  @name
end

#placement_group_type ⇒ String

Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion. Corresponds to the JSON property placementGroupType

Returns:

  • (String) 


8964
8965
8966
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8964

def placement_group_type
  @placement_group_type
end

#placement_strategy_id ⇒ Fixnum

ID of the placement strategy assigned to this placement group. Corresponds to the JSON property placementStrategyId

Returns:

  • (Fixnum) 


8969
8970
8971
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8969

def placement_strategy_id
  @placement_strategy_id
end

#pricing_schedule ⇒ Google::Apis::DfareportingV3_4::PricingSchedule

Pricing Schedule Corresponds to the JSON property pricingSchedule

Returns:



8974
8975
8976
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8974

def pricing_schedule
  @pricing_schedule
end

#primary_placement_id ⇒ Fixnum

ID of the primary placement, used to calculate the media cost of a roadblock ( placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements. Corresponds to the JSON property primaryPlacementId

Returns:

  • (Fixnum) 


8981
8982
8983
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8981

def primary_placement_id
  @primary_placement_id
end

#primary_placement_id_dimension_value ⇒ Google::Apis::DfareportingV3_4::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property primaryPlacementIdDimensionValue

Returns:



8986
8987
8988
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8986

def primary_placement_id_dimension_value
  @primary_placement_id_dimension_value
end

#site_id ⇒ Fixnum

Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion. Corresponds to the JSON property siteId

Returns:

  • (Fixnum) 


8994
8995
8996
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8994

def site_id
  @site_id
end

#site_id_dimension_value ⇒ Google::Apis::DfareportingV3_4::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property siteIdDimensionValue

Returns:



8999
9000
9001
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8999

def site_id_dimension_value
  @site_id_dimension_value
end

#subaccount_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


9005
9006
9007
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 9005

def subaccount_id
  @subaccount_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 9012

def update!(**args)
  @account_id = args[:account_id] if args.key?(:account_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)
  @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)
  @child_placement_ids = args[:child_placement_ids] if args.key?(:child_placement_ids)
  @comment = args[:comment] if args.key?(:comment)
  @content_category_id = args[:content_category_id] if args.key?(:content_category_id)
  @create_info = args[:create_info] if args.key?(:create_info)
  @directory_site_id = args[:directory_site_id] if args.key?(:directory_site_id)
  @directory_site_id_dimension_value = args[:directory_site_id_dimension_value] if args.key?(:directory_site_id_dimension_value)
  @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)
  @name = args[:name] if args.key?(:name)
  @placement_group_type = args[:placement_group_type] if args.key?(:placement_group_type)
  @placement_strategy_id = args[:placement_strategy_id] if args.key?(:placement_strategy_id)
  @pricing_schedule = args[:pricing_schedule] if args.key?(:pricing_schedule)
  @primary_placement_id = args[:primary_placement_id] if args.key?(:primary_placement_id)
  @primary_placement_id_dimension_value = args[:primary_placement_id_dimension_value] if args.key?(:primary_placement_id_dimension_value)
  @site_id = args[:site_id] if args.key?(:site_id)
  @site_id_dimension_value = args[:site_id_dimension_value] if args.key?(:site_id_dimension_value)
  @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id)
end