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.advertisers.html">advertisers</a> . <a href="displayvideo_v1.advertisers.negativeKeywordLists.html">negativeKeywordLists</a> . <a href="displayvideo_v1.advertisers.negativeKeywordLists.negativeKeywords.html">negativeKeywords</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#bulkEdit">bulkEdit(advertiserId, negativeKeywordListId, body=None, x__xgafv=None)</a></code></p> 79<p class="firstline">Bulk edits negative keywords in a single negative keyword list. The operation will delete the negative keywords provided in BulkEditNegativeKeywordsRequest.deleted_negative_keywords and then create the negative keywords provided in BulkEditNegativeKeywordsRequest.created_negative_keywords. This operation is guaranteed to be atomic and will never result in a partial success or partial failure.</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(advertiserId, negativeKeywordListId, body=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Creates a negative keyword in a negative keyword list.</p> 86<p class="toc_element"> 87 <code><a href="#delete">delete(advertiserId, negativeKeywordListId, keywordValue, x__xgafv=None)</a></code></p> 88<p class="firstline">Deletes a negative keyword from a negative keyword list.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(advertiserId, negativeKeywordListId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists negative keywords in a negative keyword list.</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(advertiserId, negativeKeywordListId, body=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Replaces all negative keywords in a single negative keyword list. The operation will replace the keywords in a negative keyword list with keywords provided in ReplaceNegativeKeywordsRequest.new_negative_keywords.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="bulkEdit">bulkEdit(advertiserId, negativeKeywordListId, body=None, x__xgafv=None)</code> 101 <pre>Bulk edits negative keywords in a single negative keyword list. The operation will delete the negative keywords provided in BulkEditNegativeKeywordsRequest.deleted_negative_keywords and then create the negative keywords provided in BulkEditNegativeKeywordsRequest.created_negative_keywords. This operation is guaranteed to be atomic and will never result in a partial success or partial failure. 102 103Args: 104 advertiserId: string, Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. (required) 105 negativeKeywordListId: string, Required. The ID of the parent negative keyword list to which the negative keywords belong. (required) 106 body: object, The request body. 107 The object takes the form of: 108 109{ # Request message for NegativeKeywordService.BulkEditNegativeKeywords. 110 "createdNegativeKeywords": [ # The negative keywords to create in batch, specified as a list of NegativeKeywords. 111 { # A negatively targeted keyword that belongs to a negative keyword list. 112 "keywordValue": "A String", # Required. Immutable. The negatively targeted keyword, for example `car insurance`. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. Valid characters are restricted to ASCII characters only. The only URL-escaping permitted is for representing whitespace between words. Leading or trailing whitespace is ignored. 113 "name": "A String", # Output only. The resource name of the negative keyword. 114 }, 115 ], 116 "deletedNegativeKeywords": [ # The negative keywords to delete in batch, specified as a list of keyword_values. 117 "A String", 118 ], 119} 120 121 x__xgafv: string, V1 error format. 122 Allowed values 123 1 - v1 error format 124 2 - v2 error format 125 126Returns: 127 An object of the form: 128 129 { # Response message for NegativeKeywordService.BulkEditNegativeKeywords. 130 "negativeKeywords": [ # The list of negative keywords that have been successfully created. This list will be absent if empty. 131 { # A negatively targeted keyword that belongs to a negative keyword list. 132 "keywordValue": "A String", # Required. Immutable. The negatively targeted keyword, for example `car insurance`. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. Valid characters are restricted to ASCII characters only. The only URL-escaping permitted is for representing whitespace between words. Leading or trailing whitespace is ignored. 133 "name": "A String", # Output only. The resource name of the negative keyword. 134 }, 135 ], 136}</pre> 137</div> 138 139<div class="method"> 140 <code class="details" id="close">close()</code> 141 <pre>Close httplib2 connections.</pre> 142</div> 143 144<div class="method"> 145 <code class="details" id="create">create(advertiserId, negativeKeywordListId, body=None, x__xgafv=None)</code> 146 <pre>Creates a negative keyword in a negative keyword list. 147 148Args: 149 advertiserId: string, Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. (required) 150 negativeKeywordListId: string, Required. The ID of the parent negative keyword list in which the negative keyword will be created. (required) 151 body: object, The request body. 152 The object takes the form of: 153 154{ # A negatively targeted keyword that belongs to a negative keyword list. 155 "keywordValue": "A String", # Required. Immutable. The negatively targeted keyword, for example `car insurance`. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. Valid characters are restricted to ASCII characters only. The only URL-escaping permitted is for representing whitespace between words. Leading or trailing whitespace is ignored. 156 "name": "A String", # Output only. The resource name of the negative keyword. 157} 158 159 x__xgafv: string, V1 error format. 160 Allowed values 161 1 - v1 error format 162 2 - v2 error format 163 164Returns: 165 An object of the form: 166 167 { # A negatively targeted keyword that belongs to a negative keyword list. 168 "keywordValue": "A String", # Required. Immutable. The negatively targeted keyword, for example `car insurance`. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. Valid characters are restricted to ASCII characters only. The only URL-escaping permitted is for representing whitespace between words. Leading or trailing whitespace is ignored. 169 "name": "A String", # Output only. The resource name of the negative keyword. 170}</pre> 171</div> 172 173<div class="method"> 174 <code class="details" id="delete">delete(advertiserId, negativeKeywordListId, keywordValue, x__xgafv=None)</code> 175 <pre>Deletes a negative keyword from a negative keyword list. 176 177Args: 178 advertiserId: string, Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. (required) 179 negativeKeywordListId: string, Required. The ID of the parent negative keyword list to which the negative keyword belongs. (required) 180 keywordValue: string, Required. The keyword value of the negative keyword to delete. (required) 181 x__xgafv: string, V1 error format. 182 Allowed values 183 1 - v1 error format 184 2 - v2 error format 185 186Returns: 187 An object of the form: 188 189 { # 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 `{}`. 190}</pre> 191</div> 192 193<div class="method"> 194 <code class="details" id="list">list(advertiserId, negativeKeywordListId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 195 <pre>Lists negative keywords in a negative keyword list. 196 197Args: 198 advertiserId: string, Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. (required) 199 negativeKeywordListId: string, Required. The ID of the parent negative keyword list to which the requested negative keywords belong. (required) 200 filter: string, Allows filtering by negative keyword fields. Supported syntax: * Filter expressions for negative keyword currently can only contain at most one * restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `keywordValue` Examples: * All negative keywords for which the keyword value contains "google": `keywordValue : "google"` 201 orderBy: string, Field by which to sort the list. Acceptable values are: * `keywordValue` (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: `keywordValue desc`. 202 pageSize: integer, Requested page size. Must be between `1` and `1000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. 203 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 `ListNegativeKeywords` method. If not specified, the first page of results will be returned. 204 x__xgafv: string, V1 error format. 205 Allowed values 206 1 - v1 error format 207 2 - v2 error format 208 209Returns: 210 An object of the form: 211 212 { # Response message for NegativeKeywordService.ListNegativeKeywords. 213 "negativeKeywords": [ # The list of negative keywords. This list will be absent if empty. 214 { # A negatively targeted keyword that belongs to a negative keyword list. 215 "keywordValue": "A String", # Required. Immutable. The negatively targeted keyword, for example `car insurance`. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. Valid characters are restricted to ASCII characters only. The only URL-escaping permitted is for representing whitespace between words. Leading or trailing whitespace is ignored. 216 "name": "A String", # Output only. The resource name of the negative keyword. 217 }, 218 ], 219 "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 `ListNegativeKeywords` method to retrieve the next page of results. 220}</pre> 221</div> 222 223<div class="method"> 224 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 225 <pre>Retrieves the next page of results. 226 227Args: 228 previous_request: The request for the previous page. (required) 229 previous_response: The response from the request for the previous page. (required) 230 231Returns: 232 A request object that you can call 'execute()' on to request the next 233 page. Returns None if there are no more items in the collection. 234 </pre> 235</div> 236 237<div class="method"> 238 <code class="details" id="replace">replace(advertiserId, negativeKeywordListId, body=None, x__xgafv=None)</code> 239 <pre>Replaces all negative keywords in a single negative keyword list. The operation will replace the keywords in a negative keyword list with keywords provided in ReplaceNegativeKeywordsRequest.new_negative_keywords. 240 241Args: 242 advertiserId: string, Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. (required) 243 negativeKeywordListId: string, Required. The ID of the parent negative keyword list to which the negative keywords belong. (required) 244 body: object, The request body. 245 The object takes the form of: 246 247{ # Request message for NegativeKeywordService.ReplaceNegativeKeywords. 248 "newNegativeKeywords": [ # The negative keywords that will replace the existing keywords in the negative keyword list, specified as a list of NegativeKeywords. 249 { # A negatively targeted keyword that belongs to a negative keyword list. 250 "keywordValue": "A String", # Required. Immutable. The negatively targeted keyword, for example `car insurance`. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. Valid characters are restricted to ASCII characters only. The only URL-escaping permitted is for representing whitespace between words. Leading or trailing whitespace is ignored. 251 "name": "A String", # Output only. The resource name of the negative keyword. 252 }, 253 ], 254} 255 256 x__xgafv: string, V1 error format. 257 Allowed values 258 1 - v1 error format 259 2 - v2 error format 260 261Returns: 262 An object of the form: 263 264 { # Response message for NegativeKeywordService.ReplaceNegativeKeywords. 265 "negativeKeywords": [ # The full list of negative keywords now present in the negative keyword list. 266 { # A negatively targeted keyword that belongs to a negative keyword list. 267 "keywordValue": "A String", # Required. Immutable. The negatively targeted keyword, for example `car insurance`. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. Valid characters are restricted to ASCII characters only. The only URL-escaping permitted is for representing whitespace between words. Leading or trailing whitespace is ignored. 268 "name": "A String", # Output only. The resource name of the negative keyword. 269 }, 270 ], 271}</pre> 272</div> 273 274</body></html>