Patch
|
|||||
|
|
||||
Updates an existing placement group. This method supports patch semantics
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns
Input
This building block consumes 80 input parameters
| Name | Format | Description |
|---|---|---|
profileId Required |
INTEGER |
User profile ID associated with this request |
id Required |
INTEGER |
Placement group ID |
accountId |
INTEGER |
Account ID of this placement group. This is a read-only field that can be left blank |
advertiserId |
INTEGER |
Advertiser ID of this placement group. This is a required field on insertion |
advertiserIdDimensionValue |
OBJECT |
Represents a DimensionValue resource |
advertiserIdDimensionValue.dimensionName |
STRING |
The name of the dimension |
advertiserIdDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
advertiserIdDimensionValue.id |
STRING |
The ID associated with the value if available |
advertiserIdDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
advertiserIdDimensionValue.matchType |
ENUMERATION |
Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
advertiserIdDimensionValue.value |
STRING |
The value of the dimension |
archived |
BOOLEAN |
Whether this placement group is archived |
campaignId |
INTEGER |
Campaign ID of this placement group. This field is required on insertion |
campaignIdDimensionValue |
OBJECT |
Represents a DimensionValue resource |
campaignIdDimensionValue.dimensionName |
STRING |
The name of the dimension |
campaignIdDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
campaignIdDimensionValue.id |
STRING |
The ID associated with the value if available |
campaignIdDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
campaignIdDimensionValue.matchType |
ENUMERATION |
Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
campaignIdDimensionValue.value |
STRING |
The value of the dimension |
childPlacementIds[] |
INTEGER |
|
comment |
STRING |
Comments for this placement group |
contentCategoryId |
INTEGER |
ID of the content category assigned to this placement group |
createInfo |
OBJECT |
Modification timestamp |
createInfo.time |
INTEGER |
Timestamp of the last change in milliseconds since epoch |
directorySiteId |
INTEGER |
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 |
OBJECT |
Represents a DimensionValue resource |
directorySiteIdDimensionValue.dimensionName |
STRING |
The name of the dimension |
directorySiteIdDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
directorySiteIdDimensionValue.id |
STRING |
The ID associated with the value if available |
directorySiteIdDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
directorySiteIdDimensionValue.matchType |
ENUMERATION |
Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
directorySiteIdDimensionValue.value |
STRING |
The value of the dimension |
externalId |
STRING |
External ID for this placement |
id |
INTEGER |
ID of this placement group. This is a read-only, auto-generated field |
idDimensionValue |
OBJECT |
Represents a DimensionValue resource |
idDimensionValue.dimensionName |
STRING |
The name of the dimension |
idDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
idDimensionValue.id |
STRING |
The ID associated with the value if available |
idDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
idDimensionValue.matchType |
ENUMERATION |
Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
idDimensionValue.value |
STRING |
The value of the dimension |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup" |
lastModifiedInfo |
OBJECT |
Modification timestamp |
lastModifiedInfo.time |
INTEGER |
Timestamp of the last change in milliseconds since epoch |
name |
STRING |
Name of this placement group. This is a required field and must be less than 256 characters long |
placementGroupType |
ENUMERATION |
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 |
INTEGER |
ID of the placement strategy assigned to this placement group |
pricingSchedule |
OBJECT |
Pricing Schedule |
pricingSchedule.capCostOption |
ENUMERATION |
Placement cap cost option |
pricingSchedule.disregardOverdelivery |
BOOLEAN |
Whether cap costs are ignored by ad serving |
pricingSchedule.endDate |
DATE |
Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion |
pricingSchedule.flighted |
BOOLEAN |
Whether this placement is flighted. If true, pricing periods will be computed automatically |
pricingSchedule.floodlightActivityId |
INTEGER |
Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA |
pricingSchedule.pricingPeriods[] |
OBJECT |
Pricing Period |
pricingSchedule.pricingPeriods[].endDate |
DATE |
Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error |
pricingSchedule.pricingPeriods[].pricingComment |
STRING |
Comments for this pricing period |
pricingSchedule.pricingPeriods[].rateOrCostNanos |
INTEGER |
Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive |
pricingSchedule.pricingPeriods[].startDate |
DATE |
Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error |
pricingSchedule.pricingPeriods[].units |
INTEGER |
Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive |
pricingSchedule.pricingType |
ENUMERATION |
Placement pricing type. This field is required on insertion |
pricingSchedule.startDate |
DATE |
Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion |
pricingSchedule.testingStartDate |
DATE |
Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error |
primaryPlacementId |
INTEGER |
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 |
OBJECT |
Represents a DimensionValue resource |
primaryPlacementIdDimensionValue.dimensionName |
STRING |
The name of the dimension |
primaryPlacementIdDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
primaryPlacementIdDimensionValue.id |
STRING |
The ID associated with the value if available |
primaryPlacementIdDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
primaryPlacementIdDimensionValue.matchType |
ENUMERATION |
Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
primaryPlacementIdDimensionValue.value |
STRING |
The value of the dimension |
siteId |
INTEGER |
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 |
OBJECT |
Represents a DimensionValue resource |
siteIdDimensionValue.dimensionName |
STRING |
The name of the dimension |
siteIdDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
siteIdDimensionValue.id |
STRING |
The ID associated with the value if available |
siteIdDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
siteIdDimensionValue.matchType |
ENUMERATION |
Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
siteIdDimensionValue.value |
STRING |
The value of the dimension |
subaccountId |
INTEGER |
Subaccount ID of this placement group. This is a read-only field that can be left blank |
= Parameter name
= Format
|
profileId INTEGER Required User profile ID associated with this request |
|
id INTEGER Required Placement group ID |
|
accountId INTEGER Account ID of this placement group. This is a read-only field that can be left blank |
|
advertiserId INTEGER Advertiser ID of this placement group. This is a required field on insertion |
|
advertiserIdDimensionValue OBJECT Represents a DimensionValue resource |
|
advertiserIdDimensionValue.dimensionName STRING The name of the dimension |
|
advertiserIdDimensionValue.etag STRING The eTag of this response for caching purposes |
|
advertiserIdDimensionValue.id STRING The ID associated with the value if available |
|
advertiserIdDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
advertiserIdDimensionValue.matchType ENUMERATION Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
|
advertiserIdDimensionValue.value STRING The value of the dimension |
|
archived BOOLEAN Whether this placement group is archived |
|
campaignId INTEGER Campaign ID of this placement group. This field is required on insertion |
|
campaignIdDimensionValue OBJECT Represents a DimensionValue resource |
|
campaignIdDimensionValue.dimensionName STRING The name of the dimension |
|
campaignIdDimensionValue.etag STRING The eTag of this response for caching purposes |
|
campaignIdDimensionValue.id STRING The ID associated with the value if available |
|
campaignIdDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
campaignIdDimensionValue.matchType ENUMERATION Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
|
campaignIdDimensionValue.value STRING The value of the dimension |
|
childPlacementIds[] INTEGER |
|
comment STRING Comments for this placement group |
|
contentCategoryId INTEGER ID of the content category assigned to this placement group |
|
createInfo OBJECT Modification timestamp |
|
createInfo.time INTEGER Timestamp of the last change in milliseconds since epoch |
|
directorySiteId INTEGER 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 OBJECT Represents a DimensionValue resource |
|
directorySiteIdDimensionValue.dimensionName STRING The name of the dimension |
|
directorySiteIdDimensionValue.etag STRING The eTag of this response for caching purposes |
|
directorySiteIdDimensionValue.id STRING The ID associated with the value if available |
|
directorySiteIdDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
directorySiteIdDimensionValue.matchType ENUMERATION Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
|
directorySiteIdDimensionValue.value STRING The value of the dimension |
|
externalId STRING External ID for this placement |
|
id INTEGER ID of this placement group. This is a read-only, auto-generated field |
|
idDimensionValue OBJECT Represents a DimensionValue resource |
|
idDimensionValue.dimensionName STRING The name of the dimension |
|
idDimensionValue.etag STRING The eTag of this response for caching purposes |
|
idDimensionValue.id STRING The ID associated with the value if available |
|
idDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
idDimensionValue.matchType ENUMERATION Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
|
idDimensionValue.value STRING The value of the dimension |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup" |
|
lastModifiedInfo OBJECT Modification timestamp |
|
lastModifiedInfo.time INTEGER Timestamp of the last change in milliseconds since epoch |
|
name STRING Name of this placement group. This is a required field and must be less than 256 characters long |
|
placementGroupType ENUMERATION 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 INTEGER ID of the placement strategy assigned to this placement group |
|
pricingSchedule OBJECT Pricing Schedule |
|
pricingSchedule.capCostOption ENUMERATION Placement cap cost option |
|
pricingSchedule.disregardOverdelivery BOOLEAN Whether cap costs are ignored by ad serving |
|
pricingSchedule.endDate DATE Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion |
|
pricingSchedule.flighted BOOLEAN Whether this placement is flighted. If true, pricing periods will be computed automatically |
|
pricingSchedule.floodlightActivityId INTEGER Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA |
|
pricingSchedule.pricingPeriods[] OBJECT Pricing Period |
|
pricingSchedule.pricingPeriods[].endDate DATE Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error |
|
pricingSchedule.pricingPeriods[].pricingComment STRING Comments for this pricing period |
|
pricingSchedule.pricingPeriods[].rateOrCostNanos INTEGER Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive |
|
pricingSchedule.pricingPeriods[].startDate DATE Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error |
|
pricingSchedule.pricingPeriods[].units INTEGER Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive |
|
pricingSchedule.pricingType ENUMERATION Placement pricing type. This field is required on insertion |
|
pricingSchedule.startDate DATE Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion |
|
pricingSchedule.testingStartDate DATE Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error |
|
primaryPlacementId INTEGER 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 OBJECT Represents a DimensionValue resource |
|
primaryPlacementIdDimensionValue.dimensionName STRING The name of the dimension |
|
primaryPlacementIdDimensionValue.etag STRING The eTag of this response for caching purposes |
|
primaryPlacementIdDimensionValue.id STRING The ID associated with the value if available |
|
primaryPlacementIdDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
primaryPlacementIdDimensionValue.matchType ENUMERATION Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
|
primaryPlacementIdDimensionValue.value STRING The value of the dimension |
|
siteId INTEGER 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 OBJECT Represents a DimensionValue resource |
|
siteIdDimensionValue.dimensionName STRING The name of the dimension |
|
siteIdDimensionValue.etag STRING The eTag of this response for caching purposes |
|
siteIdDimensionValue.id STRING The ID associated with the value if available |
|
siteIdDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
siteIdDimensionValue.matchType ENUMERATION Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
|
siteIdDimensionValue.value STRING The value of the dimension |
|
subaccountId INTEGER Subaccount ID of this placement group. This is a read-only field that can be left blank |
Output
This building block provides 78 output parameters
| Name | Format | Description |
|---|---|---|
accountId |
INTEGER |
Account ID of this placement group. This is a read-only field that can be left blank |
advertiserId |
INTEGER |
Advertiser ID of this placement group. This is a required field on insertion |
advertiserIdDimensionValue |
OBJECT |
Represents a DimensionValue resource |
advertiserIdDimensionValue.dimensionName |
STRING |
The name of the dimension |
advertiserIdDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
advertiserIdDimensionValue.id |
STRING |
The ID associated with the value if available |
advertiserIdDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
advertiserIdDimensionValue.matchType |
ENUMERATION |
Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
advertiserIdDimensionValue.value |
STRING |
The value of the dimension |
archived |
BOOLEAN |
Whether this placement group is archived |
campaignId |
INTEGER |
Campaign ID of this placement group. This field is required on insertion |
campaignIdDimensionValue |
OBJECT |
Represents a DimensionValue resource |
campaignIdDimensionValue.dimensionName |
STRING |
The name of the dimension |
campaignIdDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
campaignIdDimensionValue.id |
STRING |
The ID associated with the value if available |
campaignIdDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
campaignIdDimensionValue.matchType |
ENUMERATION |
Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
campaignIdDimensionValue.value |
STRING |
The value of the dimension |
childPlacementIds[] |
INTEGER |
|
comment |
STRING |
Comments for this placement group |
contentCategoryId |
INTEGER |
ID of the content category assigned to this placement group |
createInfo |
OBJECT |
Modification timestamp |
createInfo.time |
INTEGER |
Timestamp of the last change in milliseconds since epoch |
directorySiteId |
INTEGER |
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 |
OBJECT |
Represents a DimensionValue resource |
directorySiteIdDimensionValue.dimensionName |
STRING |
The name of the dimension |
directorySiteIdDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
directorySiteIdDimensionValue.id |
STRING |
The ID associated with the value if available |
directorySiteIdDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
directorySiteIdDimensionValue.matchType |
ENUMERATION |
Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
directorySiteIdDimensionValue.value |
STRING |
The value of the dimension |
externalId |
STRING |
External ID for this placement |
id |
INTEGER |
ID of this placement group. This is a read-only, auto-generated field |
idDimensionValue |
OBJECT |
Represents a DimensionValue resource |
idDimensionValue.dimensionName |
STRING |
The name of the dimension |
idDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
idDimensionValue.id |
STRING |
The ID associated with the value if available |
idDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
idDimensionValue.matchType |
ENUMERATION |
Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
idDimensionValue.value |
STRING |
The value of the dimension |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup" |
lastModifiedInfo |
OBJECT |
Modification timestamp |
lastModifiedInfo.time |
INTEGER |
Timestamp of the last change in milliseconds since epoch |
name |
STRING |
Name of this placement group. This is a required field and must be less than 256 characters long |
placementGroupType |
ENUMERATION |
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 |
INTEGER |
ID of the placement strategy assigned to this placement group |
pricingSchedule |
OBJECT |
Pricing Schedule |
pricingSchedule.capCostOption |
ENUMERATION |
Placement cap cost option |
pricingSchedule.disregardOverdelivery |
BOOLEAN |
Whether cap costs are ignored by ad serving |
pricingSchedule.endDate |
DATE |
Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion |
pricingSchedule.flighted |
BOOLEAN |
Whether this placement is flighted. If true, pricing periods will be computed automatically |
pricingSchedule.floodlightActivityId |
INTEGER |
Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA |
pricingSchedule.pricingPeriods[] |
OBJECT |
Pricing Period |
pricingSchedule.pricingPeriods[].endDate |
DATE |
Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error |
pricingSchedule.pricingPeriods[].pricingComment |
STRING |
Comments for this pricing period |
pricingSchedule.pricingPeriods[].rateOrCostNanos |
INTEGER |
Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive |
pricingSchedule.pricingPeriods[].startDate |
DATE |
Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error |
pricingSchedule.pricingPeriods[].units |
INTEGER |
Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive |
pricingSchedule.pricingType |
ENUMERATION |
Placement pricing type. This field is required on insertion |
pricingSchedule.startDate |
DATE |
Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion |
pricingSchedule.testingStartDate |
DATE |
Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error |
primaryPlacementId |
INTEGER |
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 |
OBJECT |
Represents a DimensionValue resource |
primaryPlacementIdDimensionValue.dimensionName |
STRING |
The name of the dimension |
primaryPlacementIdDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
primaryPlacementIdDimensionValue.id |
STRING |
The ID associated with the value if available |
primaryPlacementIdDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
primaryPlacementIdDimensionValue.matchType |
ENUMERATION |
Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
primaryPlacementIdDimensionValue.value |
STRING |
The value of the dimension |
siteId |
INTEGER |
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 |
OBJECT |
Represents a DimensionValue resource |
siteIdDimensionValue.dimensionName |
STRING |
The name of the dimension |
siteIdDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
siteIdDimensionValue.id |
STRING |
The ID associated with the value if available |
siteIdDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
siteIdDimensionValue.matchType |
ENUMERATION |
Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
siteIdDimensionValue.value |
STRING |
The value of the dimension |
subaccountId |
INTEGER |
Subaccount ID of this placement group. This is a read-only field that can be left blank |
= Parameter name
= Format
|
accountId INTEGER Account ID of this placement group. This is a read-only field that can be left blank |
|
advertiserId INTEGER Advertiser ID of this placement group. This is a required field on insertion |
|
advertiserIdDimensionValue OBJECT Represents a DimensionValue resource |
|
advertiserIdDimensionValue.dimensionName STRING The name of the dimension |
|
advertiserIdDimensionValue.etag STRING The eTag of this response for caching purposes |
|
advertiserIdDimensionValue.id STRING The ID associated with the value if available |
|
advertiserIdDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
advertiserIdDimensionValue.matchType ENUMERATION Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
|
advertiserIdDimensionValue.value STRING The value of the dimension |
|
archived BOOLEAN Whether this placement group is archived |
|
campaignId INTEGER Campaign ID of this placement group. This field is required on insertion |
|
campaignIdDimensionValue OBJECT Represents a DimensionValue resource |
|
campaignIdDimensionValue.dimensionName STRING The name of the dimension |
|
campaignIdDimensionValue.etag STRING The eTag of this response for caching purposes |
|
campaignIdDimensionValue.id STRING The ID associated with the value if available |
|
campaignIdDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
campaignIdDimensionValue.matchType ENUMERATION Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
|
campaignIdDimensionValue.value STRING The value of the dimension |
|
childPlacementIds[] INTEGER |
|
comment STRING Comments for this placement group |
|
contentCategoryId INTEGER ID of the content category assigned to this placement group |
|
createInfo OBJECT Modification timestamp |
|
createInfo.time INTEGER Timestamp of the last change in milliseconds since epoch |
|
directorySiteId INTEGER 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 OBJECT Represents a DimensionValue resource |
|
directorySiteIdDimensionValue.dimensionName STRING The name of the dimension |
|
directorySiteIdDimensionValue.etag STRING The eTag of this response for caching purposes |
|
directorySiteIdDimensionValue.id STRING The ID associated with the value if available |
|
directorySiteIdDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
directorySiteIdDimensionValue.matchType ENUMERATION Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
|
directorySiteIdDimensionValue.value STRING The value of the dimension |
|
externalId STRING External ID for this placement |
|
id INTEGER ID of this placement group. This is a read-only, auto-generated field |
|
idDimensionValue OBJECT Represents a DimensionValue resource |
|
idDimensionValue.dimensionName STRING The name of the dimension |
|
idDimensionValue.etag STRING The eTag of this response for caching purposes |
|
idDimensionValue.id STRING The ID associated with the value if available |
|
idDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
idDimensionValue.matchType ENUMERATION Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
|
idDimensionValue.value STRING The value of the dimension |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup" |
|
lastModifiedInfo OBJECT Modification timestamp |
|
lastModifiedInfo.time INTEGER Timestamp of the last change in milliseconds since epoch |
|
name STRING Name of this placement group. This is a required field and must be less than 256 characters long |
|
placementGroupType ENUMERATION 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 INTEGER ID of the placement strategy assigned to this placement group |
|
pricingSchedule OBJECT Pricing Schedule |
|
pricingSchedule.capCostOption ENUMERATION Placement cap cost option |
|
pricingSchedule.disregardOverdelivery BOOLEAN Whether cap costs are ignored by ad serving |
|
pricingSchedule.endDate DATE Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion |
|
pricingSchedule.flighted BOOLEAN Whether this placement is flighted. If true, pricing periods will be computed automatically |
|
pricingSchedule.floodlightActivityId INTEGER Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA |
|
pricingSchedule.pricingPeriods[] OBJECT Pricing Period |
|
pricingSchedule.pricingPeriods[].endDate DATE Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error |
|
pricingSchedule.pricingPeriods[].pricingComment STRING Comments for this pricing period |
|
pricingSchedule.pricingPeriods[].rateOrCostNanos INTEGER Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive |
|
pricingSchedule.pricingPeriods[].startDate DATE Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error |
|
pricingSchedule.pricingPeriods[].units INTEGER Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive |
|
pricingSchedule.pricingType ENUMERATION Placement pricing type. This field is required on insertion |
|
pricingSchedule.startDate DATE Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion |
|
pricingSchedule.testingStartDate DATE Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error |
|
primaryPlacementId INTEGER 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 OBJECT Represents a DimensionValue resource |
|
primaryPlacementIdDimensionValue.dimensionName STRING The name of the dimension |
|
primaryPlacementIdDimensionValue.etag STRING The eTag of this response for caching purposes |
|
primaryPlacementIdDimensionValue.id STRING The ID associated with the value if available |
|
primaryPlacementIdDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
primaryPlacementIdDimensionValue.matchType ENUMERATION Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
|
primaryPlacementIdDimensionValue.value STRING The value of the dimension |
|
siteId INTEGER 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 OBJECT Represents a DimensionValue resource |
|
siteIdDimensionValue.dimensionName STRING The name of the dimension |
|
siteIdDimensionValue.etag STRING The eTag of this response for caching purposes |
|
siteIdDimensionValue.id STRING The ID associated with the value if available |
|
siteIdDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
siteIdDimensionValue.matchType ENUMERATION Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
|
siteIdDimensionValue.value STRING The value of the dimension |
|
subaccountId INTEGER Subaccount ID of this placement group. This is a read-only field that can be left blank |