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">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v3_3.directorySites.html">directorySites</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#get">get(profileId, id)</a></code></p>
79<p class="firstline">Gets one directory site by ID.</p>
80<p class="toc_element">
81  <code><a href="#insert">insert(profileId, body)</a></code></p>
82<p class="firstline">Inserts a new directory site.</p>
83<p class="toc_element">
84  <code><a href="#list">list(profileId, dfpNetworkCode=None, acceptsInStreamVideoPlacements=None, pageToken=None, acceptsPublisherPaidPlacements=None, sortOrder=None, acceptsInterstitialPlacements=None, maxResults=None, active=None, searchString=None, ids=None, sortField=None)</a></code></p>
85<p class="firstline">Retrieves a list of directory sites, possibly filtered. This method supports paging.</p>
86<p class="toc_element">
87  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<h3>Method Details</h3>
90<div class="method">
91    <code class="details" id="get">get(profileId, id)</code>
92  <pre>Gets one directory site by ID.
93
94Args:
95  profileId: string, User profile ID associated with this request. (required)
96  id: string, Directory site ID. (required)
97
98Returns:
99  An object of the form:
100
101    { # 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.
102      "kind": "dfareporting#directorySite", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
103      "name": "A String", # Name of this directory site.
104      "settings": { # Directory Site Settings # Directory site settings.
105        "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads.
106        "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives.
107        "instreamVideoPlacementAccepted": True or False, # Whether this site accepts in-stream video ads.
108        "dfpSettings": { # Google Ad Manager Settings # Directory site Ad Manager settings.
109          "publisherPortalOnly": True or False, # Whether this directory site is available only via Publisher Portal.
110          "dfpNetworkCode": "A String", # Ad Manager network code for this directory site.
111          "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags.
112          "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements.
113          "dfpNetworkName": "A String", # Ad Manager network name for this directory site.
114        },
115      },
116      "url": "A String", # URL of this directory site.
117      "inpageTagFormats": [ # Tag types for regular placements.
118          #
119          # Acceptable values are:
120          # - "STANDARD"
121          # - "IFRAME_JAVASCRIPT_INPAGE"
122          # - "INTERNAL_REDIRECT_INPAGE"
123          # - "JAVASCRIPT_INPAGE"
124        "A String",
125      ],
126      "id": "A String", # ID of this directory site. This is a read-only, auto-generated field.
127      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
128        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
129        "value": "A String", # The value of the dimension.
130        "dimensionName": "A String", # The name of the dimension.
131        "etag": "A String", # The eTag of this response for caching purposes.
132        "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
133        "id": "A String", # The ID associated with the value if available.
134      },
135      "active": True or False, # Whether this directory site is active.
136      "interstitialTagFormats": [ # Tag types for interstitial placements.
137          #
138          # Acceptable values are:
139          # - "IFRAME_JAVASCRIPT_INTERSTITIAL"
140          # - "INTERNAL_REDIRECT_INTERSTITIAL"
141          # - "JAVASCRIPT_INTERSTITIAL"
142        "A String",
143      ],
144    }</pre>
145</div>
146
147<div class="method">
148    <code class="details" id="insert">insert(profileId, body)</code>
149  <pre>Inserts a new directory site.
150
151Args:
152  profileId: string, User profile ID associated with this request. (required)
153  body: object, The request body. (required)
154    The object takes the form of:
155
156{ # 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.
157    "kind": "dfareporting#directorySite", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
158    "name": "A String", # Name of this directory site.
159    "settings": { # Directory Site Settings # Directory site settings.
160      "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads.
161      "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives.
162      "instreamVideoPlacementAccepted": True or False, # Whether this site accepts in-stream video ads.
163      "dfpSettings": { # Google Ad Manager Settings # Directory site Ad Manager settings.
164        "publisherPortalOnly": True or False, # Whether this directory site is available only via Publisher Portal.
165        "dfpNetworkCode": "A String", # Ad Manager network code for this directory site.
166        "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags.
167        "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements.
168        "dfpNetworkName": "A String", # Ad Manager network name for this directory site.
169      },
170    },
171    "url": "A String", # URL of this directory site.
172    "inpageTagFormats": [ # Tag types for regular placements.
173        #
174        # Acceptable values are:
175        # - "STANDARD"
176        # - "IFRAME_JAVASCRIPT_INPAGE"
177        # - "INTERNAL_REDIRECT_INPAGE"
178        # - "JAVASCRIPT_INPAGE"
179      "A String",
180    ],
181    "id": "A String", # ID of this directory site. This is a read-only, auto-generated field.
182    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
183      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
184      "value": "A String", # The value of the dimension.
185      "dimensionName": "A String", # The name of the dimension.
186      "etag": "A String", # The eTag of this response for caching purposes.
187      "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
188      "id": "A String", # The ID associated with the value if available.
189    },
190    "active": True or False, # Whether this directory site is active.
191    "interstitialTagFormats": [ # Tag types for interstitial placements.
192        #
193        # Acceptable values are:
194        # - "IFRAME_JAVASCRIPT_INTERSTITIAL"
195        # - "INTERNAL_REDIRECT_INTERSTITIAL"
196        # - "JAVASCRIPT_INTERSTITIAL"
197      "A String",
198    ],
199  }
200
201
202Returns:
203  An object of the form:
204
205    { # 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.
206      "kind": "dfareporting#directorySite", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
207      "name": "A String", # Name of this directory site.
208      "settings": { # Directory Site Settings # Directory site settings.
209        "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads.
210        "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives.
211        "instreamVideoPlacementAccepted": True or False, # Whether this site accepts in-stream video ads.
212        "dfpSettings": { # Google Ad Manager Settings # Directory site Ad Manager settings.
213          "publisherPortalOnly": True or False, # Whether this directory site is available only via Publisher Portal.
214          "dfpNetworkCode": "A String", # Ad Manager network code for this directory site.
215          "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags.
216          "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements.
217          "dfpNetworkName": "A String", # Ad Manager network name for this directory site.
218        },
219      },
220      "url": "A String", # URL of this directory site.
221      "inpageTagFormats": [ # Tag types for regular placements.
222          #
223          # Acceptable values are:
224          # - "STANDARD"
225          # - "IFRAME_JAVASCRIPT_INPAGE"
226          # - "INTERNAL_REDIRECT_INPAGE"
227          # - "JAVASCRIPT_INPAGE"
228        "A String",
229      ],
230      "id": "A String", # ID of this directory site. This is a read-only, auto-generated field.
231      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
232        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
233        "value": "A String", # The value of the dimension.
234        "dimensionName": "A String", # The name of the dimension.
235        "etag": "A String", # The eTag of this response for caching purposes.
236        "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
237        "id": "A String", # The ID associated with the value if available.
238      },
239      "active": True or False, # Whether this directory site is active.
240      "interstitialTagFormats": [ # Tag types for interstitial placements.
241          #
242          # Acceptable values are:
243          # - "IFRAME_JAVASCRIPT_INTERSTITIAL"
244          # - "INTERNAL_REDIRECT_INTERSTITIAL"
245          # - "JAVASCRIPT_INTERSTITIAL"
246        "A String",
247      ],
248    }</pre>
249</div>
250
251<div class="method">
252    <code class="details" id="list">list(profileId, dfpNetworkCode=None, acceptsInStreamVideoPlacements=None, pageToken=None, acceptsPublisherPaidPlacements=None, sortOrder=None, acceptsInterstitialPlacements=None, maxResults=None, active=None, searchString=None, ids=None, sortField=None)</code>
253  <pre>Retrieves a list of directory sites, possibly filtered. This method supports paging.
254
255Args:
256  profileId: string, User profile ID associated with this request. (required)
257  dfpNetworkCode: string, Select only directory sites with this Ad Manager network code.
258  acceptsInStreamVideoPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
259  pageToken: string, Value of the nextPageToken from the previous result page.
260  acceptsPublisherPaidPlacements: boolean, Select only directory sites that accept publisher paid placements. This field can be left blank.
261  sortOrder: string, Order of sorted results.
262    Allowed values
263      ASCENDING -
264      DESCENDING -
265  acceptsInterstitialPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
266  maxResults: integer, Maximum number of results to return.
267  active: boolean, Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.
268  searchString: string, Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, "directory site*2015" will return objects with names like "directory site June 2015", "directory site April 2015", or simply "directory site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site" will match objects with name "my directory site", "directory site 2015" or simply, "directory site".
269  ids: string, Select only directory sites with these IDs. (repeated)
270  sortField: string, Field by which to sort the list.
271    Allowed values
272      ID -
273      NAME -
274
275Returns:
276  An object of the form:
277
278    { # Directory Site List Response
279    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
280    "kind": "dfareporting#directorySitesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySitesListResponse".
281    "directorySites": [ # Directory site collection.
282      { # 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.
283          "kind": "dfareporting#directorySite", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
284          "name": "A String", # Name of this directory site.
285          "settings": { # Directory Site Settings # Directory site settings.
286            "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads.
287            "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives.
288            "instreamVideoPlacementAccepted": True or False, # Whether this site accepts in-stream video ads.
289            "dfpSettings": { # Google Ad Manager Settings # Directory site Ad Manager settings.
290              "publisherPortalOnly": True or False, # Whether this directory site is available only via Publisher Portal.
291              "dfpNetworkCode": "A String", # Ad Manager network code for this directory site.
292              "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags.
293              "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements.
294              "dfpNetworkName": "A String", # Ad Manager network name for this directory site.
295            },
296          },
297          "url": "A String", # URL of this directory site.
298          "inpageTagFormats": [ # Tag types for regular placements.
299              #
300              # Acceptable values are:
301              # - "STANDARD"
302              # - "IFRAME_JAVASCRIPT_INPAGE"
303              # - "INTERNAL_REDIRECT_INPAGE"
304              # - "JAVASCRIPT_INPAGE"
305            "A String",
306          ],
307          "id": "A String", # ID of this directory site. This is a read-only, auto-generated field.
308          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
309            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
310            "value": "A String", # The value of the dimension.
311            "dimensionName": "A String", # The name of the dimension.
312            "etag": "A String", # The eTag of this response for caching purposes.
313            "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
314            "id": "A String", # The ID associated with the value if available.
315          },
316          "active": True or False, # Whether this directory site is active.
317          "interstitialTagFormats": [ # Tag types for interstitial placements.
318              #
319              # Acceptable values are:
320              # - "IFRAME_JAVASCRIPT_INTERSTITIAL"
321              # - "INTERNAL_REDIRECT_INTERSTITIAL"
322              # - "JAVASCRIPT_INTERSTITIAL"
323            "A String",
324          ],
325        },
326    ],
327  }</pre>
328</div>
329
330<div class="method">
331    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
332  <pre>Retrieves the next page of results.
333
334Args:
335  previous_request: The request for the previous page. (required)
336  previous_response: The response from the request for the previous page. (required)
337
338Returns:
339  A request object that you can call 'execute()' on to request the next
340  page. Returns None if there are no more items in the collection.
341    </pre>
342</div>
343
344</body></html>