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