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.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(previous_request, previous_response)</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 102Args: 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 110Returns: 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 "active": True or False, # Whether this directory site is active. 115 "id": "A String", # ID of this directory site. This is a read-only, auto-generated field. 116 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field. 117 "dimensionName": "A String", # The name of the dimension. 118 "etag": "A String", # The eTag of this response for caching purposes. 119 "id": "A String", # The ID associated with the value if available. 120 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 121 "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. 122 "value": "A String", # The value of the dimension. 123 }, 124 "inpageTagFormats": [ # Tag types for regular placements. Acceptable values are: - "STANDARD" - "IFRAME_JAVASCRIPT_INPAGE" - "INTERNAL_REDIRECT_INPAGE" - "JAVASCRIPT_INPAGE" 125 "A String", 126 ], 127 "interstitialTagFormats": [ # Tag types for interstitial placements. Acceptable values are: - "IFRAME_JAVASCRIPT_INTERSTITIAL" - "INTERNAL_REDIRECT_INTERSTITIAL" - "JAVASCRIPT_INTERSTITIAL" 128 "A String", 129 ], 130 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite". 131 "name": "A String", # Name of this directory site. 132 "settings": { # Directory Site Settings # Directory site settings. 133 "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives. 134 "dfpSettings": { # Google Ad Manager Settings # Directory site Ad Manager settings. 135 "dfpNetworkCode": "A String", # Ad Manager network code for this directory site. 136 "dfpNetworkName": "A String", # Ad Manager network name for this directory site. 137 "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements. 138 "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags. 139 "publisherPortalOnly": True or False, # Whether this directory site is available only via Publisher Portal. 140 }, 141 "instreamVideoPlacementAccepted": True or False, # Whether this site accepts in-stream video ads. 142 "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads. 143 }, 144 "url": "A String", # 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 152Args: 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 "active": True or False, # Whether this directory site is active. 159 "id": "A String", # ID of this directory site. This is a read-only, auto-generated field. 160 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field. 161 "dimensionName": "A String", # The name of the dimension. 162 "etag": "A String", # The eTag of this response for caching purposes. 163 "id": "A String", # The ID associated with the value if available. 164 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 165 "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. 166 "value": "A String", # The value of the dimension. 167 }, 168 "inpageTagFormats": [ # Tag types for regular placements. Acceptable values are: - "STANDARD" - "IFRAME_JAVASCRIPT_INPAGE" - "INTERNAL_REDIRECT_INPAGE" - "JAVASCRIPT_INPAGE" 169 "A String", 170 ], 171 "interstitialTagFormats": [ # Tag types for interstitial placements. Acceptable values are: - "IFRAME_JAVASCRIPT_INTERSTITIAL" - "INTERNAL_REDIRECT_INTERSTITIAL" - "JAVASCRIPT_INTERSTITIAL" 172 "A String", 173 ], 174 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite". 175 "name": "A String", # Name of this directory site. 176 "settings": { # Directory Site Settings # Directory site settings. 177 "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives. 178 "dfpSettings": { # Google Ad Manager Settings # Directory site Ad Manager settings. 179 "dfpNetworkCode": "A String", # Ad Manager network code for this directory site. 180 "dfpNetworkName": "A String", # Ad Manager network name for this directory site. 181 "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements. 182 "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags. 183 "publisherPortalOnly": True or False, # Whether this directory site is available only via Publisher Portal. 184 }, 185 "instreamVideoPlacementAccepted": True or False, # Whether this site accepts in-stream video ads. 186 "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads. 187 }, 188 "url": "A String", # 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 196Returns: 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 "active": True or False, # Whether this directory site is active. 201 "id": "A String", # ID of this directory site. This is a read-only, auto-generated field. 202 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field. 203 "dimensionName": "A String", # The name of the dimension. 204 "etag": "A String", # The eTag of this response for caching purposes. 205 "id": "A String", # The ID associated with the value if available. 206 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 207 "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. 208 "value": "A String", # The value of the dimension. 209 }, 210 "inpageTagFormats": [ # Tag types for regular placements. Acceptable values are: - "STANDARD" - "IFRAME_JAVASCRIPT_INPAGE" - "INTERNAL_REDIRECT_INPAGE" - "JAVASCRIPT_INPAGE" 211 "A String", 212 ], 213 "interstitialTagFormats": [ # Tag types for interstitial placements. Acceptable values are: - "IFRAME_JAVASCRIPT_INTERSTITIAL" - "INTERNAL_REDIRECT_INTERSTITIAL" - "JAVASCRIPT_INTERSTITIAL" 214 "A String", 215 ], 216 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite". 217 "name": "A String", # Name of this directory site. 218 "settings": { # Directory Site Settings # Directory site settings. 219 "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives. 220 "dfpSettings": { # Google Ad Manager Settings # Directory site Ad Manager settings. 221 "dfpNetworkCode": "A String", # Ad Manager network code for this directory site. 222 "dfpNetworkName": "A String", # Ad Manager network name for this directory site. 223 "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements. 224 "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags. 225 "publisherPortalOnly": True or False, # Whether this directory site is available only via Publisher Portal. 226 }, 227 "instreamVideoPlacementAccepted": True or False, # Whether this site accepts in-stream video ads. 228 "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads. 229 }, 230 "url": "A String", # 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 238Args: 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, "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". 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 - 256 DESCENDING - 257 x__xgafv: string, V1 error format. 258 Allowed values 259 1 - v1 error format 260 2 - v2 error format 261 262Returns: 263 An object of the form: 264 265 { # Directory Site List Response 266 "directorySites": [ # 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 "active": True or False, # Whether this directory site is active. 269 "id": "A String", # ID of this directory site. This is a read-only, auto-generated field. 270 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field. 271 "dimensionName": "A String", # The name of the dimension. 272 "etag": "A String", # The eTag of this response for caching purposes. 273 "id": "A String", # The ID associated with the value if available. 274 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 275 "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. 276 "value": "A String", # The value of the dimension. 277 }, 278 "inpageTagFormats": [ # Tag types for regular placements. Acceptable values are: - "STANDARD" - "IFRAME_JAVASCRIPT_INPAGE" - "INTERNAL_REDIRECT_INPAGE" - "JAVASCRIPT_INPAGE" 279 "A String", 280 ], 281 "interstitialTagFormats": [ # Tag types for interstitial placements. Acceptable values are: - "IFRAME_JAVASCRIPT_INTERSTITIAL" - "INTERNAL_REDIRECT_INTERSTITIAL" - "JAVASCRIPT_INTERSTITIAL" 282 "A String", 283 ], 284 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite". 285 "name": "A String", # Name of this directory site. 286 "settings": { # Directory Site Settings # Directory site settings. 287 "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives. 288 "dfpSettings": { # Google Ad Manager Settings # Directory site Ad Manager settings. 289 "dfpNetworkCode": "A String", # Ad Manager network code for this directory site. 290 "dfpNetworkName": "A String", # Ad Manager network name for this directory site. 291 "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements. 292 "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags. 293 "publisherPortalOnly": True or False, # Whether this directory site is available only via Publisher Portal. 294 }, 295 "instreamVideoPlacementAccepted": True or False, # Whether this site accepts in-stream video ads. 296 "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads. 297 }, 298 "url": "A String", # URL of this directory site. 299 }, 300 ], 301 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySitesListResponse". 302 "nextPageToken": "A String", # 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(previous_request, previous_response)</code> 308 <pre>Retrieves the next page of results. 309 310Args: 311 previous_request: The request for the previous page. (required) 312 previous_response: The response from the request for the previous page. (required) 313 314Returns: 315 A request object that you can call 'execute()' 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>