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></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="displayvideo_v1.advertisers.negativeKeywordLists.negativeKeywords.html">negativeKeywords()</a></code> 79</p> 80<p class="firstline">Returns the negativeKeywords Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#close">close()</a></code></p> 84<p class="firstline">Close httplib2 connections.</p> 85<p class="toc_element"> 86 <code><a href="#create">create(advertiserId, body=None, x__xgafv=None)</a></code></p> 87<p class="firstline">Creates a new negative keyword list. Returns the newly created negative keyword list if successful.</p> 88<p class="toc_element"> 89 <code><a href="#delete">delete(advertiserId, negativeKeywordListId, x__xgafv=None)</a></code></p> 90<p class="firstline">Deletes a negative keyword list given an advertiser ID and a negative keyword list ID.</p> 91<p class="toc_element"> 92 <code><a href="#get">get(advertiserId, negativeKeywordListId, x__xgafv=None)</a></code></p> 93<p class="firstline">Gets a negative keyword list given an advertiser ID and a negative keyword list ID.</p> 94<p class="toc_element"> 95 <code><a href="#list">list(advertiserId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 96<p class="firstline">Lists negative keyword lists based on a given advertiser id.</p> 97<p class="toc_element"> 98 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 99<p class="firstline">Retrieves the next page of results.</p> 100<p class="toc_element"> 101 <code><a href="#patch">patch(advertiserId, negativeKeywordListId, body=None, updateMask=None, x__xgafv=None)</a></code></p> 102<p class="firstline">Updates a negative keyword list. Returns the updated negative keyword list if successful.</p> 103<h3>Method Details</h3> 104<div class="method"> 105 <code class="details" id="close">close()</code> 106 <pre>Close httplib2 connections.</pre> 107</div> 108 109<div class="method"> 110 <code class="details" id="create">create(advertiserId, body=None, x__xgafv=None)</code> 111 <pre>Creates a new negative keyword list. Returns the newly created negative keyword list if successful. 112 113Args: 114 advertiserId: string, Required. The ID of the DV360 advertiser to which the negative keyword list will belong. (required) 115 body: object, The request body. 116 The object takes the form of: 117 118{ # A list of negative keywords used for targeting. 119 "advertiserId": "A String", # Output only. The unique ID of the advertiser the negative keyword list belongs to. 120 "displayName": "A String", # Required. The display name of the negative keyword list. Must be UTF-8 encoded with a maximum size of 255 bytes. 121 "name": "A String", # Output only. The resource name of the negative keyword list. 122 "negativeKeywordListId": "A String", # Output only. The unique ID of the negative keyword list. Assigned by the system. 123 "targetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this negative keyword list. 124} 125 126 x__xgafv: string, V1 error format. 127 Allowed values 128 1 - v1 error format 129 2 - v2 error format 130 131Returns: 132 An object of the form: 133 134 { # A list of negative keywords used for targeting. 135 "advertiserId": "A String", # Output only. The unique ID of the advertiser the negative keyword list belongs to. 136 "displayName": "A String", # Required. The display name of the negative keyword list. Must be UTF-8 encoded with a maximum size of 255 bytes. 137 "name": "A String", # Output only. The resource name of the negative keyword list. 138 "negativeKeywordListId": "A String", # Output only. The unique ID of the negative keyword list. Assigned by the system. 139 "targetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this negative keyword list. 140}</pre> 141</div> 142 143<div class="method"> 144 <code class="details" id="delete">delete(advertiserId, negativeKeywordListId, x__xgafv=None)</code> 145 <pre>Deletes a negative keyword list given an advertiser ID and a negative keyword list ID. 146 147Args: 148 advertiserId: string, Required. The ID of the DV360 advertiser to which the negative keyword list belongs. (required) 149 negativeKeywordListId: string, Required. The ID of the negative keyword list to delete. (required) 150 x__xgafv: string, V1 error format. 151 Allowed values 152 1 - v1 error format 153 2 - v2 error format 154 155Returns: 156 An object of the form: 157 158 { # 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 `{}`. 159}</pre> 160</div> 161 162<div class="method"> 163 <code class="details" id="get">get(advertiserId, negativeKeywordListId, x__xgafv=None)</code> 164 <pre>Gets a negative keyword list given an advertiser ID and a negative keyword list ID. 165 166Args: 167 advertiserId: string, Required. The ID of the DV360 advertiser to which the fetched negative keyword list belongs. (required) 168 negativeKeywordListId: string, Required. The ID of the negative keyword list to fetch. (required) 169 x__xgafv: string, V1 error format. 170 Allowed values 171 1 - v1 error format 172 2 - v2 error format 173 174Returns: 175 An object of the form: 176 177 { # A list of negative keywords used for targeting. 178 "advertiserId": "A String", # Output only. The unique ID of the advertiser the negative keyword list belongs to. 179 "displayName": "A String", # Required. The display name of the negative keyword list. Must be UTF-8 encoded with a maximum size of 255 bytes. 180 "name": "A String", # Output only. The resource name of the negative keyword list. 181 "negativeKeywordListId": "A String", # Output only. The unique ID of the negative keyword list. Assigned by the system. 182 "targetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this negative keyword list. 183}</pre> 184</div> 185 186<div class="method"> 187 <code class="details" id="list">list(advertiserId, pageSize=None, pageToken=None, x__xgafv=None)</code> 188 <pre>Lists negative keyword lists based on a given advertiser id. 189 190Args: 191 advertiserId: string, Required. The ID of the DV360 advertiser to which the fetched negative keyword lists belong. (required) 192 pageSize: integer, Requested page size. Must be between `1` and `100`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. 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 `ListNegativeKeywordLists` method. If not specified, the first page of results will be returned. 194 x__xgafv: string, V1 error format. 195 Allowed values 196 1 - v1 error format 197 2 - v2 error format 198 199Returns: 200 An object of the form: 201 202 { # Response message for NegativeKeywordListService.ListNegativeKeywordLists. 203 "negativeKeywordLists": [ # The list of negative keyword lists. This list will be absent if empty. 204 { # A list of negative keywords used for targeting. 205 "advertiserId": "A String", # Output only. The unique ID of the advertiser the negative keyword list belongs to. 206 "displayName": "A String", # Required. The display name of the negative keyword list. Must be UTF-8 encoded with a maximum size of 255 bytes. 207 "name": "A String", # Output only. The resource name of the negative keyword list. 208 "negativeKeywordListId": "A String", # Output only. The unique ID of the negative keyword list. Assigned by the system. 209 "targetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this negative keyword list. 210 }, 211 ], 212 "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 `ListNegativeKeywordLists` method to retrieve the next page of results. 213}</pre> 214</div> 215 216<div class="method"> 217 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 218 <pre>Retrieves the next page of results. 219 220Args: 221 previous_request: The request for the previous page. (required) 222 previous_response: The response from the request for the previous page. (required) 223 224Returns: 225 A request object that you can call 'execute()' on to request the next 226 page. Returns None if there are no more items in the collection. 227 </pre> 228</div> 229 230<div class="method"> 231 <code class="details" id="patch">patch(advertiserId, negativeKeywordListId, body=None, updateMask=None, x__xgafv=None)</code> 232 <pre>Updates a negative keyword list. Returns the updated negative keyword list if successful. 233 234Args: 235 advertiserId: string, Required. The ID of the DV360 advertiser to which the negative keyword list belongs. (required) 236 negativeKeywordListId: string, Output only. The unique ID of the negative keyword list. Assigned by the system. (required) 237 body: object, The request body. 238 The object takes the form of: 239 240{ # A list of negative keywords used for targeting. 241 "advertiserId": "A String", # Output only. The unique ID of the advertiser the negative keyword list belongs to. 242 "displayName": "A String", # Required. The display name of the negative keyword list. Must be UTF-8 encoded with a maximum size of 255 bytes. 243 "name": "A String", # Output only. The resource name of the negative keyword list. 244 "negativeKeywordListId": "A String", # Output only. The unique ID of the negative keyword list. Assigned by the system. 245 "targetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this negative keyword list. 246} 247 248 updateMask: string, Required. The mask to control which fields to update. 249 x__xgafv: string, V1 error format. 250 Allowed values 251 1 - v1 error format 252 2 - v2 error format 253 254Returns: 255 An object of the form: 256 257 { # A list of negative keywords used for targeting. 258 "advertiserId": "A String", # Output only. The unique ID of the advertiser the negative keyword list belongs to. 259 "displayName": "A String", # Required. The display name of the negative keyword list. Must be UTF-8 encoded with a maximum size of 255 bytes. 260 "name": "A String", # Output only. The resource name of the negative keyword list. 261 "negativeKeywordListId": "A String", # Output only. The unique ID of the negative keyword list. Assigned by the system. 262 "targetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this negative keyword list. 263}</pre> 264</div> 265 266</body></html>