| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <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> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#bulkEdit">bulkEdit(advertiserId, negativeKeywordListId, body=None, x__xgafv=None)</a></code></p> |
| <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> |
| <p class="toc_element"> |
| <code><a href="#create">create(advertiserId, negativeKeywordListId, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a negative keyword in a negative keyword list.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(advertiserId, negativeKeywordListId, keywordValue, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes a negative keyword from a negative keyword list.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(advertiserId, negativeKeywordListId, pageSize=None, orderBy=None, pageToken=None, filter=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists negative keywords in a negative keyword list.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="bulkEdit">bulkEdit(advertiserId, negativeKeywordListId, body=None, x__xgafv=None)</code> |
| <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. |
| |
| Args: |
| advertiserId: string, Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. (required) |
| negativeKeywordListId: string, Required. The ID of the parent negative keyword list to which the negative keywords belong. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for NegativeKeywordService.BulkEditNegativeKeywords. |
| "createdNegativeKeywords": [ # The negative keywords to create in batch, specified as a list of NegativeKeywords. |
| { # A negatively targeted keyword that belongs to a negative keyword list. |
| "name": "A String", # Output only. The resource name of the negative keyword. |
| "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. |
| }, |
| ], |
| "deletedNegativeKeywords": [ # The negative keywords to delete in batch, specified as a list of keyword_values. |
| "A String", |
| ], |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for NegativeKeywordService.BulkEditNegativeKeywords. |
| "negativeKeywords": [ # The list of negative keywords that have been successfully created. This list will be absent if empty. |
| { # A negatively targeted keyword that belongs to a negative keyword list. |
| "name": "A String", # Output only. The resource name of the negative keyword. |
| "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. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="create">create(advertiserId, negativeKeywordListId, body=None, x__xgafv=None)</code> |
| <pre>Creates a negative keyword in a negative keyword list. |
| |
| Args: |
| advertiserId: string, Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. (required) |
| negativeKeywordListId: string, Required. The ID of the parent negative keyword list in which the negative keyword will be created. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A negatively targeted keyword that belongs to a negative keyword list. |
| "name": "A String", # Output only. The resource name of the negative keyword. |
| "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. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A negatively targeted keyword that belongs to a negative keyword list. |
| "name": "A String", # Output only. The resource name of the negative keyword. |
| "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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(advertiserId, negativeKeywordListId, keywordValue, x__xgafv=None)</code> |
| <pre>Deletes a negative keyword from a negative keyword list. |
| |
| Args: |
| advertiserId: string, Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. (required) |
| negativeKeywordListId: string, Required. The ID of the parent negative keyword list to which the negative keyword belongs. (required) |
| keywordValue: string, Required. The keyword value of the negative keyword to delete. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # 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 `{}`. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(advertiserId, negativeKeywordListId, pageSize=None, orderBy=None, pageToken=None, filter=None, x__xgafv=None)</code> |
| <pre>Lists negative keywords in a negative keyword list. |
| |
| Args: |
| advertiserId: string, Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. (required) |
| negativeKeywordListId: string, Required. The ID of the parent negative keyword list to which the requested negative keywords belong. (required) |
| 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. |
| 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`. |
| 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. |
| 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"` |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for NegativeKeywordService.ListNegativeKeywords. |
| "negativeKeywords": [ # The list of negative keywords. This list will be absent if empty. |
| { # A negatively targeted keyword that belongs to a negative keyword list. |
| "name": "A String", # Output only. The resource name of the negative keyword. |
| "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. |
| }, |
| ], |
| "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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| </body></html> |
