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