1 <html><body> 2 <style> 3 4 body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13 } 14 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51 } 52 53 .toc_element { 54 margin-top: 0.5em; 55 } 56 57 .firstline { 58 margin-left: 2 em; 59 } 60 61 .method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66 } 67 68 .details { 69 font-weight: bold; 70 font-size: 14px; 71 } 72 73 </style> 74 75 <h1><a href="dfareporting_v2_7.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_7.placementGroups.html">placementGroups</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#get">get(profileId, id)</a></code></p> 79 <p class="firstline">Gets one placement group by ID.</p> 80 <p class="toc_element"> 81 <code><a href="#insert">insert(profileId, body)</a></code></p> 82 <p class="firstline">Inserts a new placement group.</p> 83 <p class="toc_element"> 84 <code><a href="#list">list(profileId, siteIds=None, placementGroupType=None, pricingTypes=None, campaignIds=None, advertiserIds=None, pageToken=None, maxStartDate=None, sortOrder=None, maxEndDate=None, placementStrategyIds=None, contentCategoryIds=None, archived=None, maxResults=None, minStartDate=None, searchString=None, minEndDate=None, directorySiteIds=None, ids=None, sortField=None)</a></code></p> 85 <p class="firstline">Retrieves a list of placement groups, possibly filtered. This method supports paging.</p> 86 <p class="toc_element"> 87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 88 <p class="firstline">Retrieves the next page of results.</p> 89 <p class="toc_element"> 90 <code><a href="#patch">patch(profileId, id, body)</a></code></p> 91 <p class="firstline">Updates an existing placement group. This method supports patch semantics.</p> 92 <p class="toc_element"> 93 <code><a href="#update">update(profileId, body)</a></code></p> 94 <p class="firstline">Updates an existing placement group.</p> 95 <h3>Method Details</h3> 96 <div class="method"> 97 <code class="details" id="get">get(profileId, id)</code> 98 <pre>Gets one placement group by ID. 99 100 Args: 101 profileId: string, User profile ID associated with this request. (required) 102 id: string, Placement group ID. (required) 103 104 Returns: 105 An object of the form: 106 107 { # Contains properties of a package or roadblock. 108 "comment": "A String", # Comments for this placement group. 109 "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. 110 "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion. 111 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 112 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 113 "value": "A String", # The value of the dimension. 114 "dimensionName": "A String", # The name of the dimension. 115 "etag": "A String", # The eTag of this response for caching purposes. 116 "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. 117 "id": "A String", # The ID associated with the value if available. 118 }, 119 "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion. 120 "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. 121 "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. 122 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 123 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 124 "value": "A String", # The value of the dimension. 125 "dimensionName": "A String", # The name of the dimension. 126 "etag": "A String", # The eTag of this response for caching purposes. 127 "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. 128 "id": "A String", # The ID associated with the value if available. 129 }, 130 "id": "A String", # ID of this placement group. This is a read-only, auto-generated field. 131 "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank. 132 "archived": True or False, # Whether this placement group is archived. 133 "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field. 134 "A String", 135 ], 136 "contentCategoryId": "A String", # ID of the content category assigned to this placement group. 137 "externalId": "A String", # External ID for this placement. 138 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field. 139 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 140 "value": "A String", # The value of the dimension. 141 "dimensionName": "A String", # The name of the dimension. 142 "etag": "A String", # The eTag of this response for caching purposes. 143 "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. 144 "id": "A String", # The ID associated with the value if available. 145 }, 146 "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field. 147 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 148 "value": "A String", # The value of the dimension. 149 "dimensionName": "A String", # The name of the dimension. 150 "etag": "A String", # The eTag of this response for caching purposes. 151 "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. 152 "id": "A String", # The ID associated with the value if available. 153 }, 154 "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field. 155 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 156 "value": "A String", # The value of the dimension. 157 "dimensionName": "A String", # The name of the dimension. 158 "etag": "A String", # The eTag of this response for caching purposes. 159 "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. 160 "id": "A String", # The ID associated with the value if available. 161 }, 162 "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field. 163 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 164 }, 165 "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. 166 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 167 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 168 "value": "A String", # The value of the dimension. 169 "dimensionName": "A String", # The name of the dimension. 170 "etag": "A String", # The eTag of this response for caching purposes. 171 "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. 172 "id": "A String", # The ID associated with the value if available. 173 }, 174 "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group. 175 "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup". 176 "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank. 177 "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long. 178 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field. 179 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 180 }, 181 "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion. 182 "startDate": "A String", # 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. 183 "endDate": "A String", # 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. 184 "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically. 185 "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving. 186 "capCostOption": "A String", # Placement cap cost option. 187 "pricingPeriods": [ # Pricing periods for this placement. 188 { # Pricing Period 189 "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. 190 "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. 191 "startDate": "A String", # 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. 192 "endDate": "A String", # 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. 193 "pricingComment": "A String", # Comments for this pricing period. 194 }, 195 ], 196 "pricingType": "A String", # Placement pricing type. This field is required on insertion. 197 "testingStartDate": "A String", # 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. 198 "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. 199 }, 200 }</pre> 201 </div> 202 203 <div class="method"> 204 <code class="details" id="insert">insert(profileId, body)</code> 205 <pre>Inserts a new placement group. 206 207 Args: 208 profileId: string, User profile ID associated with this request. (required) 209 body: object, The request body. (required) 210 The object takes the form of: 211 212 { # Contains properties of a package or roadblock. 213 "comment": "A String", # Comments for this placement group. 214 "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. 215 "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion. 216 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 217 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 218 "value": "A String", # The value of the dimension. 219 "dimensionName": "A String", # The name of the dimension. 220 "etag": "A String", # The eTag of this response for caching purposes. 221 "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. 222 "id": "A String", # The ID associated with the value if available. 223 }, 224 "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion. 225 "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. 226 "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. 227 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 228 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 229 "value": "A String", # The value of the dimension. 230 "dimensionName": "A String", # The name of the dimension. 231 "etag": "A String", # The eTag of this response for caching purposes. 232 "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. 233 "id": "A String", # The ID associated with the value if available. 234 }, 235 "id": "A String", # ID of this placement group. This is a read-only, auto-generated field. 236 "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank. 237 "archived": True or False, # Whether this placement group is archived. 238 "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field. 239 "A String", 240 ], 241 "contentCategoryId": "A String", # ID of the content category assigned to this placement group. 242 "externalId": "A String", # External ID for this placement. 243 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field. 244 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 245 "value": "A String", # The value of the dimension. 246 "dimensionName": "A String", # The name of the dimension. 247 "etag": "A String", # The eTag of this response for caching purposes. 248 "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. 249 "id": "A String", # The ID associated with the value if available. 250 }, 251 "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field. 252 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 253 "value": "A String", # The value of the dimension. 254 "dimensionName": "A String", # The name of the dimension. 255 "etag": "A String", # The eTag of this response for caching purposes. 256 "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. 257 "id": "A String", # The ID associated with the value if available. 258 }, 259 "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field. 260 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 261 "value": "A String", # The value of the dimension. 262 "dimensionName": "A String", # The name of the dimension. 263 "etag": "A String", # The eTag of this response for caching purposes. 264 "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. 265 "id": "A String", # The ID associated with the value if available. 266 }, 267 "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field. 268 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 269 }, 270 "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. 271 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 272 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 273 "value": "A String", # The value of the dimension. 274 "dimensionName": "A String", # The name of the dimension. 275 "etag": "A String", # The eTag of this response for caching purposes. 276 "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. 277 "id": "A String", # The ID associated with the value if available. 278 }, 279 "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group. 280 "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup". 281 "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank. 282 "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long. 283 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field. 284 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 285 }, 286 "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion. 287 "startDate": "A String", # 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. 288 "endDate": "A String", # 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. 289 "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically. 290 "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving. 291 "capCostOption": "A String", # Placement cap cost option. 292 "pricingPeriods": [ # Pricing periods for this placement. 293 { # Pricing Period 294 "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. 295 "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. 296 "startDate": "A String", # 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. 297 "endDate": "A String", # 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. 298 "pricingComment": "A String", # Comments for this pricing period. 299 }, 300 ], 301 "pricingType": "A String", # Placement pricing type. This field is required on insertion. 302 "testingStartDate": "A String", # 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. 303 "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. 304 }, 305 } 306 307 308 Returns: 309 An object of the form: 310 311 { # Contains properties of a package or roadblock. 312 "comment": "A String", # Comments for this placement group. 313 "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. 314 "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion. 315 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 316 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 317 "value": "A String", # The value of the dimension. 318 "dimensionName": "A String", # The name of the dimension. 319 "etag": "A String", # The eTag of this response for caching purposes. 320 "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. 321 "id": "A String", # The ID associated with the value if available. 322 }, 323 "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion. 324 "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. 325 "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. 326 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 327 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 328 "value": "A String", # The value of the dimension. 329 "dimensionName": "A String", # The name of the dimension. 330 "etag": "A String", # The eTag of this response for caching purposes. 331 "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. 332 "id": "A String", # The ID associated with the value if available. 333 }, 334 "id": "A String", # ID of this placement group. This is a read-only, auto-generated field. 335 "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank. 336 "archived": True or False, # Whether this placement group is archived. 337 "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field. 338 "A String", 339 ], 340 "contentCategoryId": "A String", # ID of the content category assigned to this placement group. 341 "externalId": "A String", # External ID for this placement. 342 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field. 343 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 344 "value": "A String", # The value of the dimension. 345 "dimensionName": "A String", # The name of the dimension. 346 "etag": "A String", # The eTag of this response for caching purposes. 347 "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. 348 "id": "A String", # The ID associated with the value if available. 349 }, 350 "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field. 351 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 352 "value": "A String", # The value of the dimension. 353 "dimensionName": "A String", # The name of the dimension. 354 "etag": "A String", # The eTag of this response for caching purposes. 355 "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. 356 "id": "A String", # The ID associated with the value if available. 357 }, 358 "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field. 359 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 360 "value": "A String", # The value of the dimension. 361 "dimensionName": "A String", # The name of the dimension. 362 "etag": "A String", # The eTag of this response for caching purposes. 363 "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. 364 "id": "A String", # The ID associated with the value if available. 365 }, 366 "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field. 367 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 368 }, 369 "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. 370 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 371 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 372 "value": "A String", # The value of the dimension. 373 "dimensionName": "A String", # The name of the dimension. 374 "etag": "A String", # The eTag of this response for caching purposes. 375 "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. 376 "id": "A String", # The ID associated with the value if available. 377 }, 378 "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group. 379 "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup". 380 "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank. 381 "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long. 382 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field. 383 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 384 }, 385 "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion. 386 "startDate": "A String", # 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. 387 "endDate": "A String", # 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. 388 "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically. 389 "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving. 390 "capCostOption": "A String", # Placement cap cost option. 391 "pricingPeriods": [ # Pricing periods for this placement. 392 { # Pricing Period 393 "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. 394 "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. 395 "startDate": "A String", # 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. 396 "endDate": "A String", # 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. 397 "pricingComment": "A String", # Comments for this pricing period. 398 }, 399 ], 400 "pricingType": "A String", # Placement pricing type. This field is required on insertion. 401 "testingStartDate": "A String", # 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. 402 "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. 403 }, 404 }</pre> 405 </div> 406 407 <div class="method"> 408 <code class="details" id="list">list(profileId, siteIds=None, placementGroupType=None, pricingTypes=None, campaignIds=None, advertiserIds=None, pageToken=None, maxStartDate=None, sortOrder=None, maxEndDate=None, placementStrategyIds=None, contentCategoryIds=None, archived=None, maxResults=None, minStartDate=None, searchString=None, minEndDate=None, directorySiteIds=None, ids=None, sortField=None)</code> 409 <pre>Retrieves a list of placement groups, possibly filtered. This method supports paging. 410 411 Args: 412 profileId: string, User profile ID associated with this request. (required) 413 siteIds: string, Select only placement groups that are associated with these sites. (repeated) 414 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. 415 Allowed values 416 PLACEMENT_PACKAGE - 417 PLACEMENT_ROADBLOCK - 418 pricingTypes: string, Select only placement groups with these pricing types. (repeated) 419 Allowed values 420 PRICING_TYPE_CPA - 421 PRICING_TYPE_CPC - 422 PRICING_TYPE_CPM - 423 PRICING_TYPE_CPM_ACTIVEVIEW - 424 PRICING_TYPE_FLAT_RATE_CLICKS - 425 PRICING_TYPE_FLAT_RATE_IMPRESSIONS - 426 campaignIds: string, Select only placement groups that belong to these campaigns. (repeated) 427 advertiserIds: string, Select only placement groups that belong to these advertisers. (repeated) 428 pageToken: string, Value of the nextPageToken from the previous result page. 429 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". 430 sortOrder: string, Order of sorted results. 431 Allowed values 432 ASCENDING - 433 DESCENDING - 434 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". 435 placementStrategyIds: string, Select only placement groups that are associated with these placement strategies. (repeated) 436 contentCategoryIds: string, Select only placement groups that are associated with these content categories. (repeated) 437 archived: boolean, Select only archived placements. Don't set this field to select both archived and non-archived placements. 438 maxResults: integer, Maximum number of results to return. 439 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". 440 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". 441 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". 442 directorySiteIds: string, Select only placement groups that are associated with these directory sites. (repeated) 443 ids: string, Select only placement groups with these IDs. (repeated) 444 sortField: string, Field by which to sort the list. 445 Allowed values 446 ID - 447 NAME - 448 449 Returns: 450 An object of the form: 451 452 { # Placement Group List Response 453 "nextPageToken": "A String", # Pagination token to be used for the next list operation. 454 "kind": "dfareporting#placementGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroupsListResponse". 455 "placementGroups": [ # Placement group collection. 456 { # Contains properties of a package or roadblock. 457 "comment": "A String", # Comments for this placement group. 458 "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. 459 "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion. 460 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 461 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 462 "value": "A String", # The value of the dimension. 463 "dimensionName": "A String", # The name of the dimension. 464 "etag": "A String", # The eTag of this response for caching purposes. 465 "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. 466 "id": "A String", # The ID associated with the value if available. 467 }, 468 "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion. 469 "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. 470 "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. 471 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 472 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 473 "value": "A String", # The value of the dimension. 474 "dimensionName": "A String", # The name of the dimension. 475 "etag": "A String", # The eTag of this response for caching purposes. 476 "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. 477 "id": "A String", # The ID associated with the value if available. 478 }, 479 "id": "A String", # ID of this placement group. This is a read-only, auto-generated field. 480 "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank. 481 "archived": True or False, # Whether this placement group is archived. 482 "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field. 483 "A String", 484 ], 485 "contentCategoryId": "A String", # ID of the content category assigned to this placement group. 486 "externalId": "A String", # External ID for this placement. 487 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field. 488 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 489 "value": "A String", # The value of the dimension. 490 "dimensionName": "A String", # The name of the dimension. 491 "etag": "A String", # The eTag of this response for caching purposes. 492 "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. 493 "id": "A String", # The ID associated with the value if available. 494 }, 495 "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field. 496 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 497 "value": "A String", # The value of the dimension. 498 "dimensionName": "A String", # The name of the dimension. 499 "etag": "A String", # The eTag of this response for caching purposes. 500 "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. 501 "id": "A String", # The ID associated with the value if available. 502 }, 503 "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field. 504 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 505 "value": "A String", # The value of the dimension. 506 "dimensionName": "A String", # The name of the dimension. 507 "etag": "A String", # The eTag of this response for caching purposes. 508 "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. 509 "id": "A String", # The ID associated with the value if available. 510 }, 511 "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field. 512 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 513 }, 514 "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. 515 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 516 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 517 "value": "A String", # The value of the dimension. 518 "dimensionName": "A String", # The name of the dimension. 519 "etag": "A String", # The eTag of this response for caching purposes. 520 "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. 521 "id": "A String", # The ID associated with the value if available. 522 }, 523 "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group. 524 "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup". 525 "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank. 526 "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long. 527 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field. 528 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 529 }, 530 "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion. 531 "startDate": "A String", # 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. 532 "endDate": "A String", # 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. 533 "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically. 534 "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving. 535 "capCostOption": "A String", # Placement cap cost option. 536 "pricingPeriods": [ # Pricing periods for this placement. 537 { # Pricing Period 538 "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. 539 "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. 540 "startDate": "A String", # 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. 541 "endDate": "A String", # 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. 542 "pricingComment": "A String", # Comments for this pricing period. 543 }, 544 ], 545 "pricingType": "A String", # Placement pricing type. This field is required on insertion. 546 "testingStartDate": "A String", # 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. 547 "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. 548 }, 549 }, 550 ], 551 }</pre> 552 </div> 553 554 <div class="method"> 555 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 556 <pre>Retrieves the next page of results. 557 558 Args: 559 previous_request: The request for the previous page. (required) 560 previous_response: The response from the request for the previous page. (required) 561 562 Returns: 563 A request object that you can call 'execute()' on to request the next 564 page. Returns None if there are no more items in the collection. 565 </pre> 566 </div> 567 568 <div class="method"> 569 <code class="details" id="patch">patch(profileId, id, body)</code> 570 <pre>Updates an existing placement group. This method supports patch semantics. 571 572 Args: 573 profileId: string, User profile ID associated with this request. (required) 574 id: string, Placement group ID. (required) 575 body: object, The request body. (required) 576 The object takes the form of: 577 578 { # Contains properties of a package or roadblock. 579 "comment": "A String", # Comments for this placement group. 580 "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. 581 "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion. 582 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 583 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 584 "value": "A String", # The value of the dimension. 585 "dimensionName": "A String", # The name of the dimension. 586 "etag": "A String", # The eTag of this response for caching purposes. 587 "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. 588 "id": "A String", # The ID associated with the value if available. 589 }, 590 "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion. 591 "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. 592 "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. 593 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 594 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 595 "value": "A String", # The value of the dimension. 596 "dimensionName": "A String", # The name of the dimension. 597 "etag": "A String", # The eTag of this response for caching purposes. 598 "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. 599 "id": "A String", # The ID associated with the value if available. 600 }, 601 "id": "A String", # ID of this placement group. This is a read-only, auto-generated field. 602 "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank. 603 "archived": True or False, # Whether this placement group is archived. 604 "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field. 605 "A String", 606 ], 607 "contentCategoryId": "A String", # ID of the content category assigned to this placement group. 608 "externalId": "A String", # External ID for this placement. 609 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field. 610 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 611 "value": "A String", # The value of the dimension. 612 "dimensionName": "A String", # The name of the dimension. 613 "etag": "A String", # The eTag of this response for caching purposes. 614 "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. 615 "id": "A String", # The ID associated with the value if available. 616 }, 617 "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field. 618 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 619 "value": "A String", # The value of the dimension. 620 "dimensionName": "A String", # The name of the dimension. 621 "etag": "A String", # The eTag of this response for caching purposes. 622 "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. 623 "id": "A String", # The ID associated with the value if available. 624 }, 625 "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field. 626 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 627 "value": "A String", # The value of the dimension. 628 "dimensionName": "A String", # The name of the dimension. 629 "etag": "A String", # The eTag of this response for caching purposes. 630 "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. 631 "id": "A String", # The ID associated with the value if available. 632 }, 633 "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field. 634 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 635 }, 636 "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. 637 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 638 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 639 "value": "A String", # The value of the dimension. 640 "dimensionName": "A String", # The name of the dimension. 641 "etag": "A String", # The eTag of this response for caching purposes. 642 "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. 643 "id": "A String", # The ID associated with the value if available. 644 }, 645 "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group. 646 "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup". 647 "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank. 648 "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long. 649 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field. 650 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 651 }, 652 "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion. 653 "startDate": "A String", # 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. 654 "endDate": "A String", # 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. 655 "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically. 656 "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving. 657 "capCostOption": "A String", # Placement cap cost option. 658 "pricingPeriods": [ # Pricing periods for this placement. 659 { # Pricing Period 660 "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. 661 "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. 662 "startDate": "A String", # 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. 663 "endDate": "A String", # 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. 664 "pricingComment": "A String", # Comments for this pricing period. 665 }, 666 ], 667 "pricingType": "A String", # Placement pricing type. This field is required on insertion. 668 "testingStartDate": "A String", # 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. 669 "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. 670 }, 671 } 672 673 674 Returns: 675 An object of the form: 676 677 { # Contains properties of a package or roadblock. 678 "comment": "A String", # Comments for this placement group. 679 "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. 680 "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion. 681 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 682 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 683 "value": "A String", # The value of the dimension. 684 "dimensionName": "A String", # The name of the dimension. 685 "etag": "A String", # The eTag of this response for caching purposes. 686 "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. 687 "id": "A String", # The ID associated with the value if available. 688 }, 689 "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion. 690 "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. 691 "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. 692 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 693 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 694 "value": "A String", # The value of the dimension. 695 "dimensionName": "A String", # The name of the dimension. 696 "etag": "A String", # The eTag of this response for caching purposes. 697 "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. 698 "id": "A String", # The ID associated with the value if available. 699 }, 700 "id": "A String", # ID of this placement group. This is a read-only, auto-generated field. 701 "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank. 702 "archived": True or False, # Whether this placement group is archived. 703 "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field. 704 "A String", 705 ], 706 "contentCategoryId": "A String", # ID of the content category assigned to this placement group. 707 "externalId": "A String", # External ID for this placement. 708 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field. 709 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 710 "value": "A String", # The value of the dimension. 711 "dimensionName": "A String", # The name of the dimension. 712 "etag": "A String", # The eTag of this response for caching purposes. 713 "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. 714 "id": "A String", # The ID associated with the value if available. 715 }, 716 "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field. 717 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 718 "value": "A String", # The value of the dimension. 719 "dimensionName": "A String", # The name of the dimension. 720 "etag": "A String", # The eTag of this response for caching purposes. 721 "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. 722 "id": "A String", # The ID associated with the value if available. 723 }, 724 "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field. 725 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 726 "value": "A String", # The value of the dimension. 727 "dimensionName": "A String", # The name of the dimension. 728 "etag": "A String", # The eTag of this response for caching purposes. 729 "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. 730 "id": "A String", # The ID associated with the value if available. 731 }, 732 "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field. 733 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 734 }, 735 "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. 736 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 737 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 738 "value": "A String", # The value of the dimension. 739 "dimensionName": "A String", # The name of the dimension. 740 "etag": "A String", # The eTag of this response for caching purposes. 741 "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. 742 "id": "A String", # The ID associated with the value if available. 743 }, 744 "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group. 745 "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup". 746 "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank. 747 "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long. 748 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field. 749 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 750 }, 751 "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion. 752 "startDate": "A String", # 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. 753 "endDate": "A String", # 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. 754 "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically. 755 "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving. 756 "capCostOption": "A String", # Placement cap cost option. 757 "pricingPeriods": [ # Pricing periods for this placement. 758 { # Pricing Period 759 "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. 760 "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. 761 "startDate": "A String", # 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. 762 "endDate": "A String", # 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. 763 "pricingComment": "A String", # Comments for this pricing period. 764 }, 765 ], 766 "pricingType": "A String", # Placement pricing type. This field is required on insertion. 767 "testingStartDate": "A String", # 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. 768 "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. 769 }, 770 }</pre> 771 </div> 772 773 <div class="method"> 774 <code class="details" id="update">update(profileId, body)</code> 775 <pre>Updates an existing placement group. 776 777 Args: 778 profileId: string, User profile ID associated with this request. (required) 779 body: object, The request body. (required) 780 The object takes the form of: 781 782 { # Contains properties of a package or roadblock. 783 "comment": "A String", # Comments for this placement group. 784 "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. 785 "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion. 786 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 787 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 788 "value": "A String", # The value of the dimension. 789 "dimensionName": "A String", # The name of the dimension. 790 "etag": "A String", # The eTag of this response for caching purposes. 791 "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. 792 "id": "A String", # The ID associated with the value if available. 793 }, 794 "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion. 795 "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. 796 "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. 797 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 798 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 799 "value": "A String", # The value of the dimension. 800 "dimensionName": "A String", # The name of the dimension. 801 "etag": "A String", # The eTag of this response for caching purposes. 802 "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. 803 "id": "A String", # The ID associated with the value if available. 804 }, 805 "id": "A String", # ID of this placement group. This is a read-only, auto-generated field. 806 "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank. 807 "archived": True or False, # Whether this placement group is archived. 808 "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field. 809 "A String", 810 ], 811 "contentCategoryId": "A String", # ID of the content category assigned to this placement group. 812 "externalId": "A String", # External ID for this placement. 813 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field. 814 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 815 "value": "A String", # The value of the dimension. 816 "dimensionName": "A String", # The name of the dimension. 817 "etag": "A String", # The eTag of this response for caching purposes. 818 "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. 819 "id": "A String", # The ID associated with the value if available. 820 }, 821 "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field. 822 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 823 "value": "A String", # The value of the dimension. 824 "dimensionName": "A String", # The name of the dimension. 825 "etag": "A String", # The eTag of this response for caching purposes. 826 "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. 827 "id": "A String", # The ID associated with the value if available. 828 }, 829 "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field. 830 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 831 "value": "A String", # The value of the dimension. 832 "dimensionName": "A String", # The name of the dimension. 833 "etag": "A String", # The eTag of this response for caching purposes. 834 "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. 835 "id": "A String", # The ID associated with the value if available. 836 }, 837 "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field. 838 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 839 }, 840 "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. 841 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 842 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 843 "value": "A String", # The value of the dimension. 844 "dimensionName": "A String", # The name of the dimension. 845 "etag": "A String", # The eTag of this response for caching purposes. 846 "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. 847 "id": "A String", # The ID associated with the value if available. 848 }, 849 "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group. 850 "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup". 851 "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank. 852 "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long. 853 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field. 854 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 855 }, 856 "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion. 857 "startDate": "A String", # 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. 858 "endDate": "A String", # 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. 859 "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically. 860 "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving. 861 "capCostOption": "A String", # Placement cap cost option. 862 "pricingPeriods": [ # Pricing periods for this placement. 863 { # Pricing Period 864 "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. 865 "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. 866 "startDate": "A String", # 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. 867 "endDate": "A String", # 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. 868 "pricingComment": "A String", # Comments for this pricing period. 869 }, 870 ], 871 "pricingType": "A String", # Placement pricing type. This field is required on insertion. 872 "testingStartDate": "A String", # 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. 873 "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. 874 }, 875 } 876 877 878 Returns: 879 An object of the form: 880 881 { # Contains properties of a package or roadblock. 882 "comment": "A String", # Comments for this placement group. 883 "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. 884 "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion. 885 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 886 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 887 "value": "A String", # The value of the dimension. 888 "dimensionName": "A String", # The name of the dimension. 889 "etag": "A String", # The eTag of this response for caching purposes. 890 "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. 891 "id": "A String", # The ID associated with the value if available. 892 }, 893 "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion. 894 "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. 895 "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. 896 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 897 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 898 "value": "A String", # The value of the dimension. 899 "dimensionName": "A String", # The name of the dimension. 900 "etag": "A String", # The eTag of this response for caching purposes. 901 "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. 902 "id": "A String", # The ID associated with the value if available. 903 }, 904 "id": "A String", # ID of this placement group. This is a read-only, auto-generated field. 905 "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank. 906 "archived": True or False, # Whether this placement group is archived. 907 "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field. 908 "A String", 909 ], 910 "contentCategoryId": "A String", # ID of the content category assigned to this placement group. 911 "externalId": "A String", # External ID for this placement. 912 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field. 913 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 914 "value": "A String", # The value of the dimension. 915 "dimensionName": "A String", # The name of the dimension. 916 "etag": "A String", # The eTag of this response for caching purposes. 917 "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. 918 "id": "A String", # The ID associated with the value if available. 919 }, 920 "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field. 921 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 922 "value": "A String", # The value of the dimension. 923 "dimensionName": "A String", # The name of the dimension. 924 "etag": "A String", # The eTag of this response for caching purposes. 925 "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. 926 "id": "A String", # The ID associated with the value if available. 927 }, 928 "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field. 929 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 930 "value": "A String", # The value of the dimension. 931 "dimensionName": "A String", # The name of the dimension. 932 "etag": "A String", # The eTag of this response for caching purposes. 933 "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. 934 "id": "A String", # The ID associated with the value if available. 935 }, 936 "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field. 937 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 938 }, 939 "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. 940 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 941 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 942 "value": "A String", # The value of the dimension. 943 "dimensionName": "A String", # The name of the dimension. 944 "etag": "A String", # The eTag of this response for caching purposes. 945 "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. 946 "id": "A String", # The ID associated with the value if available. 947 }, 948 "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group. 949 "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup". 950 "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank. 951 "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long. 952 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field. 953 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 954 }, 955 "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion. 956 "startDate": "A String", # 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. 957 "endDate": "A String", # 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. 958 "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically. 959 "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving. 960 "capCostOption": "A String", # Placement cap cost option. 961 "pricingPeriods": [ # Pricing periods for this placement. 962 { # Pricing Period 963 "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. 964 "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. 965 "startDate": "A String", # 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. 966 "endDate": "A String", # 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. 967 "pricingComment": "A String", # Comments for this pricing period. 968 }, 969 ], 970 "pricingType": "A String", # Placement pricing type. This field is required on insertion. 971 "testingStartDate": "A String", # 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. 972 "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. 973 }, 974 }</pre> 975 </div> 976 977 </body></html>
