Class: Google::Apis::DfareportingV3_3::PlacementGroup
- Inherits:
-
Object
- Object
- Google::Apis::DfareportingV3_3::PlacementGroup
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/dfareporting_v3_3/classes.rb,
generated/google/apis/dfareporting_v3_3/representations.rb,
generated/google/apis/dfareporting_v3_3/representations.rb
Overview
Contains properties of a package or roadblock.
Instance Attribute Summary collapse
-
#account_id ⇒ Fixnum
Account ID of this placement group.
-
#advertiser_id ⇒ Fixnum
Advertiser ID of this placement group.
-
#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV3_3::DimensionValue
Represents a DimensionValue resource.
-
#archived ⇒ Boolean
(also: #archived?)
Whether this placement group is archived.
-
#campaign_id ⇒ Fixnum
Campaign ID of this placement group.
-
#campaign_id_dimension_value ⇒ Google::Apis::DfareportingV3_3::DimensionValue
Represents a DimensionValue resource.
-
#child_placement_ids ⇒ Array<Fixnum>
IDs of placements which are assigned to this placement group.
-
#comment ⇒ String
Comments for this placement group.
-
#content_category_id ⇒ Fixnum
ID of the content category assigned to this placement group.
-
#create_info ⇒ Google::Apis::DfareportingV3_3::LastModifiedInfo
Modification timestamp.
-
#directory_site_id ⇒ Fixnum
Directory site ID associated with this placement group.
-
#directory_site_id_dimension_value ⇒ Google::Apis::DfareportingV3_3::DimensionValue
Represents a DimensionValue resource.
-
#external_id ⇒ String
External ID for this placement.
-
#id ⇒ Fixnum
ID of this placement group.
-
#id_dimension_value ⇒ Google::Apis::DfareportingV3_3::DimensionValue
Represents a DimensionValue resource.
-
#kind ⇒ String
Identifies what kind of resource this is.
-
#last_modified_info ⇒ Google::Apis::DfareportingV3_3::LastModifiedInfo
Modification timestamp.
-
#name ⇒ String
Name of this placement group.
-
#placement_group_type ⇒ String
Type of this placement group.
-
#placement_strategy_id ⇒ Fixnum
ID of the placement strategy assigned to this placement group.
-
#pricing_schedule ⇒ Google::Apis::DfareportingV3_3::PricingSchedule
Pricing Schedule Corresponds to the JSON property
pricingSchedule
. -
#primary_placement_id ⇒ Fixnum
ID of the primary placement, used to calculate the media cost of a roadblock ( placement group).
-
#primary_placement_id_dimension_value ⇒ Google::Apis::DfareportingV3_3::DimensionValue
Represents a DimensionValue resource.
-
#site_id ⇒ Fixnum
Site ID associated with this placement group.
-
#site_id_dimension_value ⇒ Google::Apis::DfareportingV3_3::DimensionValue
Represents a DimensionValue resource.
-
#subaccount_id ⇒ Fixnum
Subaccount ID of this placement group.
Instance Method Summary collapse
-
#initialize(**args) ⇒ PlacementGroup
constructor
A new instance of PlacementGroup.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ PlacementGroup
Returns a new instance of PlacementGroup
8602 8603 8604 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8602 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
8457 8458 8459 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8457 def account_id @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
8462 8463 8464 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8462 def advertiser_id @advertiser_id end |
#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV3_3::DimensionValue
Represents a DimensionValue resource.
Corresponds to the JSON property advertiserIdDimensionValue
8467 8468 8469 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8467 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
8472 8473 8474 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8472 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
8478 8479 8480 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8478 def campaign_id @campaign_id end |
#campaign_id_dimension_value ⇒ Google::Apis::DfareportingV3_3::DimensionValue
Represents a DimensionValue resource.
Corresponds to the JSON property campaignIdDimensionValue
8483 8484 8485 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8483 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
8489 8490 8491 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8489 def child_placement_ids @child_placement_ids end |
#comment ⇒ String
Comments for this placement group.
Corresponds to the JSON property comment
8494 8495 8496 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8494 def comment @comment end |
#content_category_id ⇒ Fixnum
ID of the content category assigned to this placement group.
Corresponds to the JSON property contentCategoryId
8499 8500 8501 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8499 def content_category_id @content_category_id end |
#create_info ⇒ Google::Apis::DfareportingV3_3::LastModifiedInfo
Modification timestamp.
Corresponds to the JSON property createInfo
8504 8505 8506 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8504 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
8512 8513 8514 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8512 def directory_site_id @directory_site_id end |
#directory_site_id_dimension_value ⇒ Google::Apis::DfareportingV3_3::DimensionValue
Represents a DimensionValue resource.
Corresponds to the JSON property directorySiteIdDimensionValue
8517 8518 8519 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8517 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
8522 8523 8524 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8522 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
8527 8528 8529 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8527 def id @id end |
#id_dimension_value ⇒ Google::Apis::DfareportingV3_3::DimensionValue
Represents a DimensionValue resource.
Corresponds to the JSON property idDimensionValue
8532 8533 8534 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8532 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
8538 8539 8540 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8538 def kind @kind end |
#last_modified_info ⇒ Google::Apis::DfareportingV3_3::LastModifiedInfo
Modification timestamp.
Corresponds to the JSON property lastModifiedInfo
8543 8544 8545 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8543 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
8549 8550 8551 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8549 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
8559 8560 8561 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8559 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
8564 8565 8566 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8564 def placement_strategy_id @placement_strategy_id end |
#pricing_schedule ⇒ Google::Apis::DfareportingV3_3::PricingSchedule
Pricing Schedule
Corresponds to the JSON property pricingSchedule
8569 8570 8571 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8569 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
8576 8577 8578 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8576 def primary_placement_id @primary_placement_id end |
#primary_placement_id_dimension_value ⇒ Google::Apis::DfareportingV3_3::DimensionValue
Represents a DimensionValue resource.
Corresponds to the JSON property primaryPlacementIdDimensionValue
8581 8582 8583 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8581 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
8589 8590 8591 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8589 def site_id @site_id end |
#site_id_dimension_value ⇒ Google::Apis::DfareportingV3_3::DimensionValue
Represents a DimensionValue resource.
Corresponds to the JSON property siteIdDimensionValue
8594 8595 8596 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8594 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
8600 8601 8602 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8600 def subaccount_id @subaccount_id end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632 8633 8634 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8607 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 |