Close httplib2 connections.
get(profileId, id, x__xgafv=None)
Gets one placement group by ID.
insert(profileId, body=None, x__xgafv=None)
Inserts a new placement group.
Retrieves a list of placement groups, possibly filtered. This method supports paging.
list_next(previous_request, previous_response)
Retrieves the next page of results.
patch(profileId, id, body=None, x__xgafv=None)
Updates an existing placement group. This method supports patch semantics.
update(profileId, body=None, x__xgafv=None)
Updates an existing placement group.
close()
Close httplib2 connections.
get(profileId, id, x__xgafv=None)
Gets one placement group by ID.
Args:
profileId: string, User profile ID associated with this request. (required)
id: string, Placement group ID. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Contains properties of a package or roadblock.
"accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
"advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"archived": True or False, # Whether this placement group is archived.
"campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
"A String",
],
"comment": "A String", # Comments for this placement group.
"contentCategoryId": "A String", # ID of the content category assigned to this placement group.
"createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"directorySiteId": "A 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.
"directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"externalId": "A String", # External ID for this placement.
"id": "A String", # ID of this placement group. This is a read-only, auto-generated field.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
"placementGroupType": "A 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.
"placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
"pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
"capCostOption": "A String", # Placement cap cost option.
"disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
"endDate": "A String",
"flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
"floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
"pricingPeriods": [ # Pricing periods for this placement.
{ # Pricing Period
"endDate": "A String",
"pricingComment": "A String", # Comments for this pricing period.
"rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
"startDate": "A String",
"units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
},
],
"pricingType": "A String", # Placement pricing type. This field is required on insertion.
"startDate": "A String",
"testingStartDate": "A String",
},
"primaryPlacementId": "A 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.
"primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"siteId": "A 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.
"siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
}
insert(profileId, body=None, x__xgafv=None)
Inserts a new placement group.
Args:
profileId: string, User profile ID associated with this request. (required)
body: object, The request body.
The object takes the form of:
{ # Contains properties of a package or roadblock.
"accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
"advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"archived": True or False, # Whether this placement group is archived.
"campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
"A String",
],
"comment": "A String", # Comments for this placement group.
"contentCategoryId": "A String", # ID of the content category assigned to this placement group.
"createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"directorySiteId": "A 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.
"directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"externalId": "A String", # External ID for this placement.
"id": "A String", # ID of this placement group. This is a read-only, auto-generated field.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
"placementGroupType": "A 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.
"placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
"pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
"capCostOption": "A String", # Placement cap cost option.
"disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
"endDate": "A String",
"flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
"floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
"pricingPeriods": [ # Pricing periods for this placement.
{ # Pricing Period
"endDate": "A String",
"pricingComment": "A String", # Comments for this pricing period.
"rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
"startDate": "A String",
"units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
},
],
"pricingType": "A String", # Placement pricing type. This field is required on insertion.
"startDate": "A String",
"testingStartDate": "A String",
},
"primaryPlacementId": "A 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.
"primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"siteId": "A 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.
"siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Contains properties of a package or roadblock.
"accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
"advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"archived": True or False, # Whether this placement group is archived.
"campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
"A String",
],
"comment": "A String", # Comments for this placement group.
"contentCategoryId": "A String", # ID of the content category assigned to this placement group.
"createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"directorySiteId": "A 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.
"directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"externalId": "A String", # External ID for this placement.
"id": "A String", # ID of this placement group. This is a read-only, auto-generated field.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
"placementGroupType": "A 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.
"placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
"pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
"capCostOption": "A String", # Placement cap cost option.
"disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
"endDate": "A String",
"flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
"floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
"pricingPeriods": [ # Pricing periods for this placement.
{ # Pricing Period
"endDate": "A String",
"pricingComment": "A String", # Comments for this pricing period.
"rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
"startDate": "A String",
"units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
},
],
"pricingType": "A String", # Placement pricing type. This field is required on insertion.
"startDate": "A String",
"testingStartDate": "A String",
},
"primaryPlacementId": "A 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.
"primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"siteId": "A 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.
"siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
}
list(profileId, advertiserIds=None, archived=None, campaignIds=None, contentCategoryIds=None, directorySiteIds=None, ids=None, maxEndDate=None, maxResults=None, maxStartDate=None, minEndDate=None, minStartDate=None, pageToken=None, placementGroupType=None, placementStrategyIds=None, pricingTypes=None, searchString=None, siteIds=None, sortField=None, sortOrder=None, x__xgafv=None)
Retrieves a list of placement groups, possibly filtered. This method supports paging.
Args:
profileId: string, User profile ID associated with this request. (required)
advertiserIds: string, Select only placement groups that belong to these advertisers. (repeated)
archived: boolean, Select only archived placements. Don't set this field to select both archived and non-archived placements.
campaignIds: string, Select only placement groups that belong to these campaigns. (repeated)
contentCategoryIds: string, Select only placement groups that are associated with these content categories. (repeated)
directorySiteIds: string, Select only placement groups that are associated with these directory sites. (repeated)
ids: string, Select only placement groups with these IDs. (repeated)
maxEndDate: string, Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd".
maxResults: integer, Maximum number of results to return.
maxStartDate: string, Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd".
minEndDate: string, Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd".
minStartDate: string, Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd".
pageToken: string, Value of the nextPageToken from the previous result page.
placementGroupType: string, Select only placement groups belonging with this group type. 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.
Allowed values
PLACEMENT_PACKAGE -
PLACEMENT_ROADBLOCK -
placementStrategyIds: string, Select only placement groups that are associated with these placement strategies. (repeated)
pricingTypes: string, Select only placement groups with these pricing types. (repeated)
Allowed values
PRICING_TYPE_CPM -
PRICING_TYPE_CPC -
PRICING_TYPE_CPA -
PRICING_TYPE_FLAT_RATE_IMPRESSIONS -
PRICING_TYPE_FLAT_RATE_CLICKS -
PRICING_TYPE_CPM_ACTIVEVIEW -
searchString: string, Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placement groups with names like "placement group June 2015", "placement group May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementgroup" will match placement groups with name "my placementgroup", "placementgroup 2015", or simply "placementgroup".
siteIds: string, Select only placement groups that are associated with these sites. (repeated)
sortField: string, Field by which to sort the list.
Allowed values
ID -
NAME -
sortOrder: string, Order of sorted results.
Allowed values
ASCENDING -
DESCENDING -
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Placement Group List Response
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroupsListResponse".
"nextPageToken": "A String", # Pagination token to be used for the next list operation.
"placementGroups": [ # Placement group collection.
{ # Contains properties of a package or roadblock.
"accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
"advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"archived": True or False, # Whether this placement group is archived.
"campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
"A String",
],
"comment": "A String", # Comments for this placement group.
"contentCategoryId": "A String", # ID of the content category assigned to this placement group.
"createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"directorySiteId": "A 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.
"directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"externalId": "A String", # External ID for this placement.
"id": "A String", # ID of this placement group. This is a read-only, auto-generated field.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
"placementGroupType": "A 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.
"placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
"pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
"capCostOption": "A String", # Placement cap cost option.
"disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
"endDate": "A String",
"flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
"floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
"pricingPeriods": [ # Pricing periods for this placement.
{ # Pricing Period
"endDate": "A String",
"pricingComment": "A String", # Comments for this pricing period.
"rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
"startDate": "A String",
"units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
},
],
"pricingType": "A String", # Placement pricing type. This field is required on insertion.
"startDate": "A String",
"testingStartDate": "A String",
},
"primaryPlacementId": "A 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.
"primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"siteId": "A 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.
"siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
},
],
}
list_next(previous_request, previous_response)
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(profileId, id, body=None, x__xgafv=None)
Updates an existing placement group. This method supports patch semantics.
Args:
profileId: string, User profile ID associated with this request. (required)
id: string, PlacementGroup ID. (required)
body: object, The request body.
The object takes the form of:
{ # Contains properties of a package or roadblock.
"accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
"advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"archived": True or False, # Whether this placement group is archived.
"campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
"A String",
],
"comment": "A String", # Comments for this placement group.
"contentCategoryId": "A String", # ID of the content category assigned to this placement group.
"createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"directorySiteId": "A 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.
"directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"externalId": "A String", # External ID for this placement.
"id": "A String", # ID of this placement group. This is a read-only, auto-generated field.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
"placementGroupType": "A 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.
"placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
"pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
"capCostOption": "A String", # Placement cap cost option.
"disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
"endDate": "A String",
"flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
"floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
"pricingPeriods": [ # Pricing periods for this placement.
{ # Pricing Period
"endDate": "A String",
"pricingComment": "A String", # Comments for this pricing period.
"rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
"startDate": "A String",
"units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
},
],
"pricingType": "A String", # Placement pricing type. This field is required on insertion.
"startDate": "A String",
"testingStartDate": "A String",
},
"primaryPlacementId": "A 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.
"primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"siteId": "A 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.
"siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Contains properties of a package or roadblock.
"accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
"advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"archived": True or False, # Whether this placement group is archived.
"campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
"A String",
],
"comment": "A String", # Comments for this placement group.
"contentCategoryId": "A String", # ID of the content category assigned to this placement group.
"createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"directorySiteId": "A 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.
"directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"externalId": "A String", # External ID for this placement.
"id": "A String", # ID of this placement group. This is a read-only, auto-generated field.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
"placementGroupType": "A 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.
"placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
"pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
"capCostOption": "A String", # Placement cap cost option.
"disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
"endDate": "A String",
"flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
"floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
"pricingPeriods": [ # Pricing periods for this placement.
{ # Pricing Period
"endDate": "A String",
"pricingComment": "A String", # Comments for this pricing period.
"rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
"startDate": "A String",
"units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
},
],
"pricingType": "A String", # Placement pricing type. This field is required on insertion.
"startDate": "A String",
"testingStartDate": "A String",
},
"primaryPlacementId": "A 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.
"primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"siteId": "A 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.
"siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
}
update(profileId, body=None, x__xgafv=None)
Updates an existing placement group.
Args:
profileId: string, User profile ID associated with this request. (required)
body: object, The request body.
The object takes the form of:
{ # Contains properties of a package or roadblock.
"accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
"advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"archived": True or False, # Whether this placement group is archived.
"campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
"A String",
],
"comment": "A String", # Comments for this placement group.
"contentCategoryId": "A String", # ID of the content category assigned to this placement group.
"createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"directorySiteId": "A 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.
"directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"externalId": "A String", # External ID for this placement.
"id": "A String", # ID of this placement group. This is a read-only, auto-generated field.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
"placementGroupType": "A 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.
"placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
"pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
"capCostOption": "A String", # Placement cap cost option.
"disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
"endDate": "A String",
"flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
"floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
"pricingPeriods": [ # Pricing periods for this placement.
{ # Pricing Period
"endDate": "A String",
"pricingComment": "A String", # Comments for this pricing period.
"rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
"startDate": "A String",
"units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
},
],
"pricingType": "A String", # Placement pricing type. This field is required on insertion.
"startDate": "A String",
"testingStartDate": "A String",
},
"primaryPlacementId": "A 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.
"primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"siteId": "A 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.
"siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Contains properties of a package or roadblock.
"accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
"advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"archived": True or False, # Whether this placement group is archived.
"campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
"A String",
],
"comment": "A String", # Comments for this placement group.
"contentCategoryId": "A String", # ID of the content category assigned to this placement group.
"createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"directorySiteId": "A 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.
"directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"externalId": "A String", # External ID for this placement.
"id": "A String", # ID of this placement group. This is a read-only, auto-generated field.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
"placementGroupType": "A 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.
"placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
"pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
"capCostOption": "A String", # Placement cap cost option.
"disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
"endDate": "A String",
"flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
"floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
"pricingPeriods": [ # Pricing periods for this placement.
{ # Pricing Period
"endDate": "A String",
"pricingComment": "A String", # Comments for this pricing period.
"rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
"startDate": "A String",
"units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
},
],
"pricingType": "A String", # Placement pricing type. This field is required on insertion.
"startDate": "A String",
"testingStartDate": "A String",
},
"primaryPlacementId": "A 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.
"primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"siteId": "A 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.
"siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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.
"value": "A String", # The value of the dimension.
},
"subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
}