| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 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="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="#create">create(partnerId, channelId, body=None, advertiserId=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Creates a site in a channel.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#delete">delete(partnerId, channelId, urlOrAppId, advertiserId=None, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Deletes a site from a channel.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#list">list(partnerId, channelId, pageToken=None, orderBy=None, advertiserId=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Lists sites in a channel.</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="bulkEdit">bulkEdit(partnerId, channelId, body=None, x__xgafv=None)</code> |
| 95 | <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. |
| 96 | |
| 97 | Args: |
| 98 | partnerId: string, The ID of the partner that owns the parent channel. (required) |
| 99 | channelId: string, Required. The ID of the parent channel to which the sites belong. (required) |
| 100 | body: object, The request body. |
| 101 | The object takes the form of: |
| 102 | |
| 103 | { # Request message for SiteService.BulkEditSites. |
| 104 | "deletedSites": [ # The sites to delete in batch, specified as a list of site url_or_app_ids. |
| 105 | "A String", |
| 106 | ], |
| 107 | "advertiserId": "A String", # The ID of the advertiser that owns the parent channel. |
| 108 | "partnerId": "A String", # The ID of the partner that owns the parent channel. |
| 109 | "createdSites": [ # The sites to create in batch, specified as a list of Sites. |
| 110 | { # A single site. Sites are apps or websites belonging to a channel. |
| 111 | "urlOrAppId": "A String", # Required. The URL or app ID of the site. Must be UTF-8 encoded with a maximum length of 240 bytes. |
| 112 | "name": "A String", # Output only. The resource name of the site. |
| 113 | }, |
| 114 | ], |
| 115 | } |
| 116 | |
| 117 | x__xgafv: string, V1 error format. |
| 118 | Allowed values |
| 119 | 1 - v1 error format |
| 120 | 2 - v2 error format |
| 121 | |
| 122 | Returns: |
| 123 | An object of the form: |
| 124 | |
| 125 | { # Response message for SiteService.BulkEditSites. |
| 126 | "sites": [ # The list of sites that have been successfully created. This list will be absent if empty. |
| 127 | { # A single site. Sites are apps or websites belonging to a channel. |
| 128 | "urlOrAppId": "A String", # Required. The URL or app ID of the site. Must be UTF-8 encoded with a maximum length of 240 bytes. |
| 129 | "name": "A String", # Output only. The resource name of the site. |
| 130 | }, |
| 131 | ], |
| 132 | }</pre> |
| 133 | </div> |
| 134 | |
| 135 | <div class="method"> |
| 136 | <code class="details" id="create">create(partnerId, channelId, body=None, advertiserId=None, x__xgafv=None)</code> |
| 137 | <pre>Creates a site in a channel. |
| 138 | |
| 139 | Args: |
| 140 | partnerId: string, The ID of the partner that owns the parent channel. (required) |
| 141 | channelId: string, Required. The ID of the parent channel in which the site will be created. (required) |
| 142 | body: object, The request body. |
| 143 | The object takes the form of: |
| 144 | |
| 145 | { # A single site. Sites are apps or websites belonging to a channel. |
| 146 | "urlOrAppId": "A String", # Required. The URL or app ID of the site. Must be UTF-8 encoded with a maximum length of 240 bytes. |
| 147 | "name": "A String", # Output only. The resource name of the site. |
| 148 | } |
| 149 | |
| 150 | advertiserId: string, The ID of the advertiser that owns the parent channel. |
| 151 | x__xgafv: string, V1 error format. |
| 152 | Allowed values |
| 153 | 1 - v1 error format |
| 154 | 2 - v2 error format |
| 155 | |
| 156 | Returns: |
| 157 | An object of the form: |
| 158 | |
| 159 | { # A single site. Sites are apps or websites belonging to a channel. |
| 160 | "urlOrAppId": "A String", # Required. The URL or app ID of the site. Must be UTF-8 encoded with a maximum length of 240 bytes. |
| 161 | "name": "A String", # Output only. The resource name of the site. |
| 162 | }</pre> |
| 163 | </div> |
| 164 | |
| 165 | <div class="method"> |
| 166 | <code class="details" id="delete">delete(partnerId, channelId, urlOrAppId, advertiserId=None, x__xgafv=None)</code> |
| 167 | <pre>Deletes a site from a channel. |
| 168 | |
| 169 | Args: |
| 170 | partnerId: string, The ID of the partner that owns the parent channel. (required) |
| 171 | channelId: string, Required. The ID of the parent channel to which the site belongs. (required) |
| 172 | urlOrAppId: string, Required. The URL or app ID of the site to delete. (required) |
| 173 | advertiserId: string, The ID of the advertiser that owns the parent channel. |
| 174 | x__xgafv: string, V1 error format. |
| 175 | Allowed values |
| 176 | 1 - v1 error format |
| 177 | 2 - v2 error format |
| 178 | |
| 179 | Returns: |
| 180 | An object of the form: |
| 181 | |
| 182 | { # 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 `{}`. |
| 183 | }</pre> |
| 184 | </div> |
| 185 | |
| 186 | <div class="method"> |
| 187 | <code class="details" id="list">list(partnerId, channelId, pageToken=None, orderBy=None, advertiserId=None, pageSize=None, filter=None, x__xgafv=None)</code> |
| 188 | <pre>Lists sites in a channel. |
| 189 | |
| 190 | Args: |
| 191 | partnerId: string, The ID of the partner that owns the parent channel. (required) |
| 192 | channelId: string, Required. The ID of the parent channel to which the requested sites belong. (required) |
| 193 | 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. |
| 194 | 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`. |
| 195 | advertiserId: string, The ID of the advertiser that owns the parent channel. |
| 196 | pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| 197 | 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"` |
| 198 | x__xgafv: string, V1 error format. |
| 199 | Allowed values |
| 200 | 1 - v1 error format |
| 201 | 2 - v2 error format |
| 202 | |
| 203 | Returns: |
| 204 | An object of the form: |
| 205 | |
| 206 | { # Response message for SiteService.ListSites. |
| 207 | "sites": [ # The list of sites. This list will be absent if empty. |
| 208 | { # A single site. Sites are apps or websites belonging to a channel. |
| 209 | "urlOrAppId": "A String", # Required. The URL or app ID of the site. Must be UTF-8 encoded with a maximum length of 240 bytes. |
| 210 | "name": "A String", # Output only. The resource name of the site. |
| 211 | }, |
| 212 | ], |
| 213 | "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. |
| 214 | }</pre> |
| 215 | </div> |
| 216 | |
| 217 | <div class="method"> |
| 218 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 219 | <pre>Retrieves the next page of results. |
| 220 | |
| 221 | Args: |
| 222 | previous_request: The request for the previous page. (required) |
| 223 | previous_response: The response from the request for the previous page. (required) |
| 224 | |
| 225 | Returns: |
| 226 | A request object that you can call 'execute()' on to request the next |
| 227 | page. Returns None if there are no more items in the collection. |
| 228 | </pre> |
| 229 | </div> |
| 230 | |
| 231 | </body></html> |