1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="dfareporting_v3_5.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_5.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 "id": "A String", # ID of this directory site. This is a read-only, auto-generated field. 115 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field. 116 "dimensionName": "A String", # The name of the dimension. 117 "etag": "A String", # The eTag of this response for caching purposes. 118 "id": "A String", # The ID associated with the value if available. 119 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 120 "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. 121 "value": "A String", # The value of the dimension. 122 }, 123 "inpageTagFormats": [ # Tag types for regular placements. Acceptable values are: - "STANDARD" - "IFRAME_JAVASCRIPT_INPAGE" - "INTERNAL_REDIRECT_INPAGE" - "JAVASCRIPT_INPAGE" 124 "A String", 125 ], 126 "interstitialTagFormats": [ # Tag types for interstitial placements. Acceptable values are: - "IFRAME_JAVASCRIPT_INTERSTITIAL" - "INTERNAL_REDIRECT_INTERSTITIAL" - "JAVASCRIPT_INTERSTITIAL" 127 "A String", 128 ], 129 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite". 130 "name": "A String", # Name of this directory site. 131 "settings": { # Directory Site Settings # Directory site settings. 132 "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives. 133 "dfpSettings": { # Google Ad Manager Settings # Directory site Ad Manager settings. 134 "dfpNetworkCode": "A String", # Ad Manager network code for this directory site. 135 "dfpNetworkName": "A String", # Ad Manager network name for this directory site. 136 "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements. 137 "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags. 138 "publisherPortalOnly": True or False, # Whether this directory site is available only via Publisher Portal. 139 }, 140 "instreamVideoPlacementAccepted": True or False, # Whether this site accepts in-stream video ads. 141 "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads. 142 }, 143 "url": "A String", # URL of this directory site. 144}</pre> 145</div> 146 147<div class="method"> 148 <code class="details" id="insert">insert(profileId, body=None, x__xgafv=None)</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. 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 "id": "A String", # ID of this directory site. This is a read-only, auto-generated field. 158 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field. 159 "dimensionName": "A String", # The name of the dimension. 160 "etag": "A String", # The eTag of this response for caching purposes. 161 "id": "A String", # The ID associated with the value if available. 162 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 163 "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. 164 "value": "A String", # The value of the dimension. 165 }, 166 "inpageTagFormats": [ # Tag types for regular placements. Acceptable values are: - "STANDARD" - "IFRAME_JAVASCRIPT_INPAGE" - "INTERNAL_REDIRECT_INPAGE" - "JAVASCRIPT_INPAGE" 167 "A String", 168 ], 169 "interstitialTagFormats": [ # Tag types for interstitial placements. Acceptable values are: - "IFRAME_JAVASCRIPT_INTERSTITIAL" - "INTERNAL_REDIRECT_INTERSTITIAL" - "JAVASCRIPT_INTERSTITIAL" 170 "A String", 171 ], 172 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite". 173 "name": "A String", # Name of this directory site. 174 "settings": { # Directory Site Settings # Directory site settings. 175 "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives. 176 "dfpSettings": { # Google Ad Manager Settings # Directory site Ad Manager settings. 177 "dfpNetworkCode": "A String", # Ad Manager network code for this directory site. 178 "dfpNetworkName": "A String", # Ad Manager network name for this directory site. 179 "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements. 180 "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags. 181 "publisherPortalOnly": True or False, # Whether this directory site is available only via Publisher Portal. 182 }, 183 "instreamVideoPlacementAccepted": True or False, # Whether this site accepts in-stream video ads. 184 "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads. 185 }, 186 "url": "A String", # URL of this directory site. 187} 188 189 x__xgafv: string, V1 error format. 190 Allowed values 191 1 - v1 error format 192 2 - v2 error format 193 194Returns: 195 An object of the form: 196 197 { # 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. 198 "id": "A String", # ID of this directory site. This is a read-only, auto-generated field. 199 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field. 200 "dimensionName": "A String", # The name of the dimension. 201 "etag": "A String", # The eTag of this response for caching purposes. 202 "id": "A String", # The ID associated with the value if available. 203 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 204 "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. 205 "value": "A String", # The value of the dimension. 206 }, 207 "inpageTagFormats": [ # Tag types for regular placements. Acceptable values are: - "STANDARD" - "IFRAME_JAVASCRIPT_INPAGE" - "INTERNAL_REDIRECT_INPAGE" - "JAVASCRIPT_INPAGE" 208 "A String", 209 ], 210 "interstitialTagFormats": [ # Tag types for interstitial placements. Acceptable values are: - "IFRAME_JAVASCRIPT_INTERSTITIAL" - "INTERNAL_REDIRECT_INTERSTITIAL" - "JAVASCRIPT_INTERSTITIAL" 211 "A String", 212 ], 213 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite". 214 "name": "A String", # Name of this directory site. 215 "settings": { # Directory Site Settings # Directory site settings. 216 "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives. 217 "dfpSettings": { # Google Ad Manager Settings # Directory site Ad Manager settings. 218 "dfpNetworkCode": "A String", # Ad Manager network code for this directory site. 219 "dfpNetworkName": "A String", # Ad Manager network name for this directory site. 220 "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements. 221 "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags. 222 "publisherPortalOnly": True or False, # Whether this directory site is available only via Publisher Portal. 223 }, 224 "instreamVideoPlacementAccepted": True or False, # Whether this site accepts in-stream video ads. 225 "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads. 226 }, 227 "url": "A String", # URL of this directory site. 228}</pre> 229</div> 230 231<div class="method"> 232 <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> 233 <pre>Retrieves a list of directory sites, possibly filtered. This method supports paging. 234 235Args: 236 profileId: string, User profile ID associated with this request. (required) 237 acceptsInStreamVideoPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned. 238 acceptsInterstitialPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned. 239 acceptsPublisherPaidPlacements: boolean, Select only directory sites that accept publisher paid placements. This field can be left blank. 240 active: boolean, Select only active directory sites. Leave blank to retrieve both active and inactive directory sites. 241 dfpNetworkCode: string, Select only directory sites with this Ad Manager network code. 242 ids: string, Select only directory sites with these IDs. (repeated) 243 maxResults: integer, Maximum number of results to return. 244 pageToken: string, Value of the nextPageToken from the previous result page. 245 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". 246 sortField: string, Field by which to sort the list. 247 Allowed values 248 ID - 249 NAME - 250 sortOrder: string, Order of sorted results. 251 Allowed values 252 ASCENDING - 253 DESCENDING - 254 x__xgafv: string, V1 error format. 255 Allowed values 256 1 - v1 error format 257 2 - v2 error format 258 259Returns: 260 An object of the form: 261 262 { # Directory Site List Response 263 "directorySites": [ # Directory site collection. 264 { # 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. 265 "id": "A String", # ID of this directory site. This is a read-only, auto-generated field. 266 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field. 267 "dimensionName": "A String", # The name of the dimension. 268 "etag": "A String", # The eTag of this response for caching purposes. 269 "id": "A String", # The ID associated with the value if available. 270 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 271 "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. 272 "value": "A String", # The value of the dimension. 273 }, 274 "inpageTagFormats": [ # Tag types for regular placements. Acceptable values are: - "STANDARD" - "IFRAME_JAVASCRIPT_INPAGE" - "INTERNAL_REDIRECT_INPAGE" - "JAVASCRIPT_INPAGE" 275 "A String", 276 ], 277 "interstitialTagFormats": [ # Tag types for interstitial placements. Acceptable values are: - "IFRAME_JAVASCRIPT_INTERSTITIAL" - "INTERNAL_REDIRECT_INTERSTITIAL" - "JAVASCRIPT_INTERSTITIAL" 278 "A String", 279 ], 280 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite". 281 "name": "A String", # Name of this directory site. 282 "settings": { # Directory Site Settings # Directory site settings. 283 "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives. 284 "dfpSettings": { # Google Ad Manager Settings # Directory site Ad Manager settings. 285 "dfpNetworkCode": "A String", # Ad Manager network code for this directory site. 286 "dfpNetworkName": "A String", # Ad Manager network name for this directory site. 287 "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements. 288 "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags. 289 "publisherPortalOnly": True or False, # Whether this directory site is available only via Publisher Portal. 290 }, 291 "instreamVideoPlacementAccepted": True or False, # Whether this site accepts in-stream video ads. 292 "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads. 293 }, 294 "url": "A String", # URL of this directory site. 295 }, 296 ], 297 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySitesListResponse". 298 "nextPageToken": "A String", # Pagination token to be used for the next list operation. 299}</pre> 300</div> 301 302<div class="method"> 303 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 304 <pre>Retrieves the next page of results. 305 306Args: 307 previous_request: The request for the previous page. (required) 308 previous_response: The response from the request for the previous page. (required) 309 310Returns: 311 A request object that you can call 'execute()' on to request the next 312 page. Returns None if there are no more items in the collection. 313 </pre> 314</div> 315 316</body></html>