Debian Codegraph @

docs/dyn/dfareporting_v4.directorySites.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="dfareporting_v4.html">Campaign Manager 360 API</a> . <a href="dfareporting_v4.directorySites.html">directorySites</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 directory site 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 directory site.</p>
86 <p class="toc_element">
87 <code><a href="#list">list(profileId, acceptsInStreamVideoPlacements=None, acceptsInterstitialPlacements=None, acceptsPublisherPaidPlacements=None, active=None, dfpNetworkCode=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Retrieves a list of directory sites, possibly filtered. This method supports paging.</p>
89 <p class="toc_element">
90 <code><a href="#list_next">list_next()</a></code></p>
91 <p class="firstline">Retrieves the next page of results.</p>
92 <h3>Method Details</h3>
93 <div class="method">
94 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96 </div>
97
98 <div class="method">
99 <code class="details" id="get">get(profileId, id, x__xgafv=None)</code>
100 <pre>Gets one directory site by ID.
101
102 Args:
103 profileId: string, User profile ID associated with this request. (required)
104 id: string, Directory site ID. (required)
105 x__xgafv: string, V1 error format.
106 Allowed values
107 1 - v1 error format
108 2 - v2 error format
109
110 Returns:
111 An object of the form:
112
113 { # DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.
114 &quot;id&quot;: &quot;A String&quot;, # ID of this directory site. This is a read-only, auto-generated field.
115 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
116 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
117 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
118 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
119 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
120 &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.
121 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
122 },
123 &quot;inpageTagFormats&quot;: [ # Tag types for regular placements. Acceptable values are: - &quot;STANDARD&quot; - &quot;IFRAME_JAVASCRIPT_INPAGE&quot; - &quot;INTERNAL_REDIRECT_INPAGE&quot; - &quot;JAVASCRIPT_INPAGE&quot;
124 &quot;A String&quot;,
125 ],
126 &quot;interstitialTagFormats&quot;: [ # Tag types for interstitial placements. Acceptable values are: - &quot;IFRAME_JAVASCRIPT_INTERSTITIAL&quot; - &quot;INTERNAL_REDIRECT_INTERSTITIAL&quot; - &quot;JAVASCRIPT_INTERSTITIAL&quot;
127 &quot;A String&quot;,
128 ],
129 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#directorySite&quot;.
130 &quot;name&quot;: &quot;A String&quot;, # Name of this directory site.
131 &quot;publisherSpecificationId&quot;: &quot;A String&quot;, # Output only. Default publisher specification ID of video placements under this directory site. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max
132 &quot;settings&quot;: { # Directory Site Settings # Directory site settings.
133 &quot;activeViewOptOut&quot;: True or False, # Whether this directory site has disabled active view creatives.
134 &quot;dfpSettings&quot;: { # Google Ad Manager Settings # Directory site Ad Manager settings.
135 &quot;dfpNetworkCode&quot;: &quot;A String&quot;, # Ad Manager network code for this directory site.
136 &quot;dfpNetworkName&quot;: &quot;A String&quot;, # Ad Manager network name for this directory site.
137 &quot;programmaticPlacementAccepted&quot;: True or False, # Whether this directory site accepts programmatic placements.
138 &quot;pubPaidPlacementAccepted&quot;: True or False, # Whether this directory site accepts publisher-paid tags.
139 &quot;publisherPortalOnly&quot;: True or False, # Whether this directory site is available only via Publisher Portal.
140 },
141 &quot;instreamVideoPlacementAccepted&quot;: True or False, # Whether this site accepts in-stream video ads.
142 &quot;interstitialPlacementAccepted&quot;: True or False, # Whether this site accepts interstitial ads.
143 },
144 &quot;url&quot;: &quot;A String&quot;, # URL of this directory site.
145 }</pre>
146 </div>
147
148 <div class="method">
149 <code class="details" id="insert">insert(profileId, body=None, x__xgafv=None)</code>
150 <pre>Inserts a new directory site.
151
152 Args:
153 profileId: string, User profile ID associated with this request. (required)
154 body: object, The request body.
155 The object takes the form of:
156
157 { # DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.
158 &quot;id&quot;: &quot;A String&quot;, # ID of this directory site. This is a read-only, auto-generated field.
159 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. 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;inpageTagFormats&quot;: [ # Tag types for regular placements. Acceptable values are: - &quot;STANDARD&quot; - &quot;IFRAME_JAVASCRIPT_INPAGE&quot; - &quot;INTERNAL_REDIRECT_INPAGE&quot; - &quot;JAVASCRIPT_INPAGE&quot;
168 &quot;A String&quot;,
169 ],
170 &quot;interstitialTagFormats&quot;: [ # Tag types for interstitial placements. Acceptable values are: - &quot;IFRAME_JAVASCRIPT_INTERSTITIAL&quot; - &quot;INTERNAL_REDIRECT_INTERSTITIAL&quot; - &quot;JAVASCRIPT_INTERSTITIAL&quot;
171 &quot;A String&quot;,
172 ],
173 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#directorySite&quot;.
174 &quot;name&quot;: &quot;A String&quot;, # Name of this directory site.
175 &quot;publisherSpecificationId&quot;: &quot;A String&quot;, # Output only. Default publisher specification ID of video placements under this directory site. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max
176 &quot;settings&quot;: { # Directory Site Settings # Directory site settings.
177 &quot;activeViewOptOut&quot;: True or False, # Whether this directory site has disabled active view creatives.
178 &quot;dfpSettings&quot;: { # Google Ad Manager Settings # Directory site Ad Manager settings.
179 &quot;dfpNetworkCode&quot;: &quot;A String&quot;, # Ad Manager network code for this directory site.
180 &quot;dfpNetworkName&quot;: &quot;A String&quot;, # Ad Manager network name for this directory site.
181 &quot;programmaticPlacementAccepted&quot;: True or False, # Whether this directory site accepts programmatic placements.
182 &quot;pubPaidPlacementAccepted&quot;: True or False, # Whether this directory site accepts publisher-paid tags.
183 &quot;publisherPortalOnly&quot;: True or False, # Whether this directory site is available only via Publisher Portal.
184 },
185 &quot;instreamVideoPlacementAccepted&quot;: True or False, # Whether this site accepts in-stream video ads.
186 &quot;interstitialPlacementAccepted&quot;: True or False, # Whether this site accepts interstitial ads.
187 },
188 &quot;url&quot;: &quot;A String&quot;, # URL of this directory site.
189 }
190
191 x__xgafv: string, V1 error format.
192 Allowed values
193 1 - v1 error format
194 2 - v2 error format
195
196 Returns:
197 An object of the form:
198
199 { # DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.
200 &quot;id&quot;: &quot;A String&quot;, # ID of this directory site. This is a read-only, auto-generated field.
201 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
202 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
203 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
204 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
205 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
206 &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.
207 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
208 },
209 &quot;inpageTagFormats&quot;: [ # Tag types for regular placements. Acceptable values are: - &quot;STANDARD&quot; - &quot;IFRAME_JAVASCRIPT_INPAGE&quot; - &quot;INTERNAL_REDIRECT_INPAGE&quot; - &quot;JAVASCRIPT_INPAGE&quot;
210 &quot;A String&quot;,
211 ],
212 &quot;interstitialTagFormats&quot;: [ # Tag types for interstitial placements. Acceptable values are: - &quot;IFRAME_JAVASCRIPT_INTERSTITIAL&quot; - &quot;INTERNAL_REDIRECT_INTERSTITIAL&quot; - &quot;JAVASCRIPT_INTERSTITIAL&quot;
213 &quot;A String&quot;,
214 ],
215 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#directorySite&quot;.
216 &quot;name&quot;: &quot;A String&quot;, # Name of this directory site.
217 &quot;publisherSpecificationId&quot;: &quot;A String&quot;, # Output only. Default publisher specification ID of video placements under this directory site. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max
218 &quot;settings&quot;: { # Directory Site Settings # Directory site settings.
219 &quot;activeViewOptOut&quot;: True or False, # Whether this directory site has disabled active view creatives.
220 &quot;dfpSettings&quot;: { # Google Ad Manager Settings # Directory site Ad Manager settings.
221 &quot;dfpNetworkCode&quot;: &quot;A String&quot;, # Ad Manager network code for this directory site.
222 &quot;dfpNetworkName&quot;: &quot;A String&quot;, # Ad Manager network name for this directory site.
223 &quot;programmaticPlacementAccepted&quot;: True or False, # Whether this directory site accepts programmatic placements.
224 &quot;pubPaidPlacementAccepted&quot;: True or False, # Whether this directory site accepts publisher-paid tags.
225 &quot;publisherPortalOnly&quot;: True or False, # Whether this directory site is available only via Publisher Portal.
226 },
227 &quot;instreamVideoPlacementAccepted&quot;: True or False, # Whether this site accepts in-stream video ads.
228 &quot;interstitialPlacementAccepted&quot;: True or False, # Whether this site accepts interstitial ads.
229 },
230 &quot;url&quot;: &quot;A String&quot;, # URL of this directory site.
231 }</pre>
232 </div>
233
234 <div class="method">
235 <code class="details" id="list">list(profileId, acceptsInStreamVideoPlacements=None, acceptsInterstitialPlacements=None, acceptsPublisherPaidPlacements=None, active=None, dfpNetworkCode=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, x__xgafv=None)</code>
236 <pre>Retrieves a list of directory sites, possibly filtered. This method supports paging.
237
238 Args:
239 profileId: string, User profile ID associated with this request. (required)
240 acceptsInStreamVideoPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
241 acceptsInterstitialPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
242 acceptsPublisherPaidPlacements: boolean, Select only directory sites that accept publisher paid placements. This field can be left blank.
243 active: boolean, Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.
244 dfpNetworkCode: string, Select only directory sites with this Ad Manager network code.
245 ids: string, Select only directory sites with these IDs. (repeated)
246 maxResults: integer, Maximum number of results to return.
247 pageToken: string, Value of the nextPageToken from the previous result page.
248 searchString: string, Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, &quot;directory site*2015&quot; will return objects with names like &quot;directory site June 2015&quot;, &quot;directory site April 2015&quot;, or simply &quot;directory site 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;directory site&quot; will match objects with name &quot;my directory site&quot;, &quot;directory site 2015&quot; or simply, &quot;directory site&quot;.
249 sortField: string, Field by which to sort the list.
250 Allowed values
251 ID -
252 NAME -
253 sortOrder: string, Order of sorted results.
254 Allowed values
255 ASCENDING - Ascending order.
256 DESCENDING - Descending order.
257 x__xgafv: string, V1 error format.
258 Allowed values
259 1 - v1 error format
260 2 - v2 error format
261
262 Returns:
263 An object of the form:
264
265 { # Directory Site List Response
266 &quot;directorySites&quot;: [ # Directory site collection.
267 { # DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.
268 &quot;id&quot;: &quot;A String&quot;, # ID of this directory site. This is a read-only, auto-generated field.
269 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
270 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
271 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
272 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
273 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
274 &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.
275 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
276 },
277 &quot;inpageTagFormats&quot;: [ # Tag types for regular placements. Acceptable values are: - &quot;STANDARD&quot; - &quot;IFRAME_JAVASCRIPT_INPAGE&quot; - &quot;INTERNAL_REDIRECT_INPAGE&quot; - &quot;JAVASCRIPT_INPAGE&quot;
278 &quot;A String&quot;,
279 ],
280 &quot;interstitialTagFormats&quot;: [ # Tag types for interstitial placements. Acceptable values are: - &quot;IFRAME_JAVASCRIPT_INTERSTITIAL&quot; - &quot;INTERNAL_REDIRECT_INTERSTITIAL&quot; - &quot;JAVASCRIPT_INTERSTITIAL&quot;
281 &quot;A String&quot;,
282 ],
283 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#directorySite&quot;.
284 &quot;name&quot;: &quot;A String&quot;, # Name of this directory site.
285 &quot;publisherSpecificationId&quot;: &quot;A String&quot;, # Output only. Default publisher specification ID of video placements under this directory site. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max
286 &quot;settings&quot;: { # Directory Site Settings # Directory site settings.
287 &quot;activeViewOptOut&quot;: True or False, # Whether this directory site has disabled active view creatives.
288 &quot;dfpSettings&quot;: { # Google Ad Manager Settings # Directory site Ad Manager settings.
289 &quot;dfpNetworkCode&quot;: &quot;A String&quot;, # Ad Manager network code for this directory site.
290 &quot;dfpNetworkName&quot;: &quot;A String&quot;, # Ad Manager network name for this directory site.
291 &quot;programmaticPlacementAccepted&quot;: True or False, # Whether this directory site accepts programmatic placements.
292 &quot;pubPaidPlacementAccepted&quot;: True or False, # Whether this directory site accepts publisher-paid tags.
293 &quot;publisherPortalOnly&quot;: True or False, # Whether this directory site is available only via Publisher Portal.
294 },
295 &quot;instreamVideoPlacementAccepted&quot;: True or False, # Whether this site accepts in-stream video ads.
296 &quot;interstitialPlacementAccepted&quot;: True or False, # Whether this site accepts interstitial ads.
297 },
298 &quot;url&quot;: &quot;A String&quot;, # URL of this directory site.
299 },
300 ],
301 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#directorySitesListResponse&quot;.
302 &quot;nextPageToken&quot;: &quot;A String&quot;, # Pagination token to be used for the next list operation.
303 }</pre>
304 </div>
305
306 <div class="method">
307 <code class="details" id="list_next">list_next()</code>
308 <pre>Retrieves the next page of results.
309
310 Args:
311 previous_request: The request for the previous page. (required)
312 previous_response: The response from the request for the previous page. (required)
313
314 Returns:
315 A request object that you can call &#x27;execute()&#x27; on to request the next
316 page. Returns None if there are no more items in the collection.
317 </pre>
318 </div>
319
320 </body></html>