PlacementGroup

import type { PlacementGroup } from "https://googleapis.deno.dev/v1/dfareporting:v4.ts";

Contains properties of a package or roadblock.

interface PlacementGroup {

accountId?: bigint;

activeStatus?:

| "PLACEMENT_STATUS_UNKNOWN"

| "PLACEMENT_STATUS_ACTIVE"

| "PLACEMENT_STATUS_INACTIVE"

| "PLACEMENT_STATUS_ARCHIVED"

| "PLACEMENT_STATUS_PERMANENTLY_ARCHIVED";

advertiserId?: bigint;

advertiserIdDimensionValue?: DimensionValue;

campaignId?: bigint;

campaignIdDimensionValue?: DimensionValue;

childPlacementIds?: bigint[];

comment?: string;

contentCategoryId?: bigint;

createInfo?: LastModifiedInfo;

directorySiteId?: bigint;

directorySiteIdDimensionValue?: DimensionValue;

externalId?: string;

id?: bigint;

idDimensionValue?: DimensionValue;

kind?: string;

lastModifiedInfo?: LastModifiedInfo;

name?: string;

placementGroupType?: "PLACEMENT_PACKAGE" | "PLACEMENT_ROADBLOCK";

placementStrategyId?: bigint;

pricingSchedule?: PricingSchedule;

primaryPlacementId?: bigint;

primaryPlacementIdDimensionValue?: DimensionValue;

siteId?: bigint;

siteIdDimensionValue?: DimensionValue;

subaccountId?: bigint;

}

§Properties

accountId?: bigint

[src]

Account ID of this placement group. This is a read-only field that can be left blank.

activeStatus?: "PLACEMENT_STATUS_UNKNOWN" | "PLACEMENT_STATUS_ACTIVE" | "PLACEMENT_STATUS_INACTIVE" | "PLACEMENT_STATUS_ARCHIVED" | "PLACEMENT_STATUS_PERMANENTLY_ARCHIVED"

[src]

Whether this placement group is active, inactive, archived or permanently archived.

advertiserId?: bigint

[src]

Advertiser ID of this placement group. This is a required field on insertion.

advertiserIdDimensionValue?: DimensionValue

[src]

Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.

campaignId?: bigint

[src]

Campaign ID of this placement group. This field is required on insertion.

campaignIdDimensionValue?: DimensionValue

[src]

Dimension value for the ID of the campaign. This is a read-only, auto-generated field.

childPlacementIds?: bigint[]

[src]

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

comment?: string

[src]

Comments for this placement group.

contentCategoryId?: bigint

[src]

ID of the content category assigned to this placement group.

createInfo?: LastModifiedInfo

[src]

Information about the creation of this placement group. This is a read-only field.

directorySiteId?: bigint

[src]

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.

directorySiteIdDimensionValue?: DimensionValue

[src]

Dimension value for the ID of the directory site. This is a read-only, auto-generated field.

externalId?: string

[src]

External ID for this placement.

id?: bigint

[src]

ID of this placement group. This is a read-only, auto-generated field.

idDimensionValue?: DimensionValue

[src]

Dimension value for the ID of this placement group. This is a read-only, auto-generated field.

kind?: string

[src]

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

lastModifiedInfo?: LastModifiedInfo

[src]

Information about the most recent modification of this placement group. This is a read-only field.

name?: string

[src]

Name of this placement group. This is a required field and must be less than 256 characters long.

placementGroupType?: "PLACEMENT_PACKAGE" | "PLACEMENT_ROADBLOCK"

[src]

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.

placementStrategyId?: bigint

[src]

ID of the placement strategy assigned to this placement group.

pricingSchedule?: PricingSchedule

[src]

Pricing schedule of this placement group. This field is required on insertion.

primaryPlacementId?: bigint

[src]

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.

primaryPlacementIdDimensionValue?: DimensionValue

[src]

Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.

siteId?: bigint

[src]

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.

siteIdDimensionValue?: DimensionValue

[src]

Dimension value for the ID of the site. This is a read-only, auto-generated field.

subaccountId?: bigint

[src]

Subaccount ID of this placement group. This is a read-only field that can be left blank.