Class: Google::Apis::DfareportingV2_5::PlacementGroup

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dfareporting_v2_5/classes.rb,
generated/google/apis/dfareporting_v2_5/representations.rb,
generated/google/apis/dfareporting_v2_5/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.



8104
8105
8106
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 8104

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

Instance Attribute Details

#account_id ⇒ String

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

Returns:

  • (String) 


7959
7960
7961
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7959

def 
  @account_id
end

#advertiser_id ⇒ String

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

Returns:

  • (String) 


7964
7965
7966
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7964

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV2_5::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue

Returns:



7969
7970
7971
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7969

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) 


7974
7975
7976
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7974

def archived
  @archived
end

#campaign_id ⇒ String

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

Returns:

  • (String) 


7980
7981
7982
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7980

def campaign_id
  @campaign_id
end

#campaign_id_dimension_value ⇒ Google::Apis::DfareportingV2_5::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property campaignIdDimensionValue

Returns:



7985
7986
7987
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7985

def campaign_id_dimension_value
  @campaign_id_dimension_value
end

#child_placement_ids ⇒ Array<String>

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<String>) 


7991
7992
7993
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7991

def child_placement_ids
  @child_placement_ids
end

#comment ⇒ String

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

Returns:

  • (String) 


7996
7997
7998
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7996

def comment
  @comment
end

#content_category_id ⇒ String

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

Returns:

  • (String) 


8001
8002
8003
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 8001

def content_category_id
  @content_category_id
end

#create_info ⇒ Google::Apis::DfareportingV2_5::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property createInfo

Returns:



8006
8007
8008
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 8006

def create_info
  @create_info
end

#directory_site_id ⇒ String

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:

  • (String) 


8014
8015
8016
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 8014

def directory_site_id
  @directory_site_id
end

#directory_site_id_dimension_value ⇒ Google::Apis::DfareportingV2_5::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property directorySiteIdDimensionValue

Returns:



8019
8020
8021
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 8019

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) 


8024
8025
8026
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 8024

def external_id
  @external_id
end

#id ⇒ String

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

Returns:

  • (String) 


8029
8030
8031
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 8029

def id
  @id
end

#id_dimension_value ⇒ Google::Apis::DfareportingV2_5::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



8034
8035
8036
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 8034

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) 


8040
8041
8042
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 8040

def kind
  @kind
end

#last_modified_info ⇒ Google::Apis::DfareportingV2_5::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property lastModifiedInfo

Returns:



8045
8046
8047
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 8045

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) 


8051
8052
8053
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 8051

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) 


8061
8062
8063
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 8061

def placement_group_type
  @placement_group_type
end

#placement_strategy_id ⇒ String

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

Returns:

  • (String) 


8066
8067
8068
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 8066

def placement_strategy_id
  @placement_strategy_id
end

#pricing_schedule ⇒ Google::Apis::DfareportingV2_5::PricingSchedule

Pricing Schedule Corresponds to the JSON property pricingSchedule

Returns:



8071
8072
8073
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 8071

def pricing_schedule
  @pricing_schedule
end

#primary_placement_id ⇒ String

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:

  • (String) 


8078
8079
8080
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 8078

def primary_placement_id
  @primary_placement_id
end

#primary_placement_id_dimension_value ⇒ Google::Apis::DfareportingV2_5::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property primaryPlacementIdDimensionValue

Returns:



8083
8084
8085
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 8083

def primary_placement_id_dimension_value
  @primary_placement_id_dimension_value
end

#site_id ⇒ String

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:

  • (String) 


8091
8092
8093
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 8091

def site_id
  @site_id
end

#site_id_dimension_value ⇒ Google::Apis::DfareportingV2_5::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property siteIdDimensionValue

Returns:



8096
8097
8098
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 8096

def site_id_dimension_value
  @site_id_dimension_value
end

#subaccount_id ⇒ String

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

Returns:

  • (String) 


8102
8103
8104
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 8102

def subaccount_id
  @subaccount_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 8109

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