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="displayvideo_v1.html">Display & Video 360 API</a> . <a href="displayvideo_v1.partners.html">partners</a> . <a href="displayvideo_v1.partners.channels.html">channels</a> . <a href="displayvideo_v1.partners.channels.sites.html">sites</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#bulkEdit">bulkEdit(partnerId, channelId, body=None, x__xgafv=None)</a></code></p> 79<p class="firstline">Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites.</p> 80<p class="toc_element"> 81 <code><a href="#close">close()</a></code></p> 82<p class="firstline">Close httplib2 connections.</p> 83<p class="toc_element"> 84 <code><a href="#create">create(partnerId, channelId, advertiserId=None, body=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Creates a site in a channel.</p> 86<p class="toc_element"> 87 <code><a href="#delete">delete(partnerId, channelId, urlOrAppId, advertiserId=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Deletes a site from a channel.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(partnerId, channelId, advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists sites in a channel.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<p class="toc_element"> 96 <code><a href="#replace">replace(partnerId, channelId, body=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest.new_sites.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="bulkEdit">bulkEdit(partnerId, channelId, body=None, x__xgafv=None)</code> 101 <pre>Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites. 102 103Args: 104 partnerId: string, The ID of the partner that owns the parent channel. (required) 105 channelId: string, Required. The ID of the parent channel to which the sites belong. (required) 106 body: object, The request body. 107 The object takes the form of: 108 109{ # Request message for SiteService.BulkEditSites. 110 "advertiserId": "A String", # The ID of the advertiser that owns the parent channel. 111 "createdSites": [ # The sites to create in batch, specified as a list of Sites. 112 { # A single site. Sites are apps or websites belonging to a channel. 113 "name": "A String", # Output only. The resource name of the site. 114 "urlOrAppId": "A String", # Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes. 115 }, 116 ], 117 "deletedSites": [ # The sites to delete in batch, specified as a list of site url_or_app_ids. 118 "A String", 119 ], 120 "partnerId": "A String", # The ID of the partner that owns the parent channel. 121} 122 123 x__xgafv: string, V1 error format. 124 Allowed values 125 1 - v1 error format 126 2 - v2 error format 127 128Returns: 129 An object of the form: 130 131 { # Response message for SiteService.BulkEditSites. 132 "sites": [ # The list of sites that have been successfully created. This list will be absent if empty. 133 { # A single site. Sites are apps or websites belonging to a channel. 134 "name": "A String", # Output only. The resource name of the site. 135 "urlOrAppId": "A String", # Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes. 136 }, 137 ], 138}</pre> 139</div> 140 141<div class="method"> 142 <code class="details" id="close">close()</code> 143 <pre>Close httplib2 connections.</pre> 144</div> 145 146<div class="method"> 147 <code class="details" id="create">create(partnerId, channelId, advertiserId=None, body=None, x__xgafv=None)</code> 148 <pre>Creates a site in a channel. 149 150Args: 151 partnerId: string, The ID of the partner that owns the parent channel. (required) 152 channelId: string, Required. The ID of the parent channel in which the site will be created. (required) 153 body: object, The request body. 154 The object takes the form of: 155 156{ # A single site. Sites are apps or websites belonging to a channel. 157 "name": "A String", # Output only. The resource name of the site. 158 "urlOrAppId": "A String", # Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes. 159} 160 161 advertiserId: string, The ID of the advertiser that owns the parent channel. 162 x__xgafv: string, V1 error format. 163 Allowed values 164 1 - v1 error format 165 2 - v2 error format 166 167Returns: 168 An object of the form: 169 170 { # A single site. Sites are apps or websites belonging to a channel. 171 "name": "A String", # Output only. The resource name of the site. 172 "urlOrAppId": "A String", # Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes. 173}</pre> 174</div> 175 176<div class="method"> 177 <code class="details" id="delete">delete(partnerId, channelId, urlOrAppId, advertiserId=None, x__xgafv=None)</code> 178 <pre>Deletes a site from a channel. 179 180Args: 181 partnerId: string, The ID of the partner that owns the parent channel. (required) 182 channelId: string, Required. The ID of the parent channel to which the site belongs. (required) 183 urlOrAppId: string, Required. The URL or app ID of the site to delete. (required) 184 advertiserId: string, The ID of the advertiser that owns the parent channel. 185 x__xgafv: string, V1 error format. 186 Allowed values 187 1 - v1 error format 188 2 - v2 error format 189 190Returns: 191 An object of the form: 192 193 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 194}</pre> 195</div> 196 197<div class="method"> 198 <code class="details" id="list">list(partnerId, channelId, advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 199 <pre>Lists sites in a channel. 200 201Args: 202 partnerId: string, The ID of the partner that owns the parent channel. (required) 203 channelId: string, Required. The ID of the parent channel to which the requested sites belong. (required) 204 advertiserId: string, The ID of the advertiser that owns the parent channel. 205 filter: string, Allows filtering by site fields. Supported syntax: * Filter expressions for site currently can only contain at most one * restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `urlOrAppId` Examples: * All sites for which the URL or app ID contains "google": `urlOrAppId : "google"` 206 orderBy: string, Field by which to sort the list. Acceptable values are: * `urlOrAppId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `urlOrAppId desc`. 207 pageSize: integer, Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. 208 pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListSites` method. If not specified, the first page of results will be returned. 209 x__xgafv: string, V1 error format. 210 Allowed values 211 1 - v1 error format 212 2 - v2 error format 213 214Returns: 215 An object of the form: 216 217 { # Response message for SiteService.ListSites. 218 "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListSites` method to retrieve the next page of results. 219 "sites": [ # The list of sites. This list will be absent if empty. 220 { # A single site. Sites are apps or websites belonging to a channel. 221 "name": "A String", # Output only. The resource name of the site. 222 "urlOrAppId": "A String", # Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes. 223 }, 224 ], 225}</pre> 226</div> 227 228<div class="method"> 229 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 230 <pre>Retrieves the next page of results. 231 232Args: 233 previous_request: The request for the previous page. (required) 234 previous_response: The response from the request for the previous page. (required) 235 236Returns: 237 A request object that you can call 'execute()' on to request the next 238 page. Returns None if there are no more items in the collection. 239 </pre> 240</div> 241 242<div class="method"> 243 <code class="details" id="replace">replace(partnerId, channelId, body=None, x__xgafv=None)</code> 244 <pre>Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest.new_sites. 245 246Args: 247 partnerId: string, The ID of the partner that owns the parent channel. (required) 248 channelId: string, Required. The ID of the parent channel whose sites will be replaced. (required) 249 body: object, The request body. 250 The object takes the form of: 251 252{ # Request message for SiteService.ReplaceSites. 253 "advertiserId": "A String", # The ID of the advertiser that owns the parent channel. 254 "newSites": [ # The sites that will replace the existing sites assigned to the channel, specified as a list of Sites. 255 { # A single site. Sites are apps or websites belonging to a channel. 256 "name": "A String", # Output only. The resource name of the site. 257 "urlOrAppId": "A String", # Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes. 258 }, 259 ], 260 "partnerId": "A String", # The ID of the partner that owns the parent channel. 261} 262 263 x__xgafv: string, V1 error format. 264 Allowed values 265 1 - v1 error format 266 2 - v2 error format 267 268Returns: 269 An object of the form: 270 271 { # Response message for SiteService.ReplaceSites. 272 "sites": [ # The list of sites in the channel after replacing. 273 { # A single site. Sites are apps or websites belonging to a channel. 274 "name": "A String", # Output only. The resource name of the site. 275 "urlOrAppId": "A String", # Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes. 276 }, 277 ], 278}</pre> 279</div> 280 281</body></html>