| <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.locationLists.html">locationLists</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="displayvideo_v1.advertisers.locationLists.assignedLocations.html">assignedLocations()</a></code> |
| </p> |
| <p class="firstline">Returns the assignedLocations Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="#create">create(advertiserId, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a new location list. Returns the newly created location list if successful.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(advertiserId, locationListId, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets a location list.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(advertiserId, filter=None, pageSize=None, pageToken=None, orderBy=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists location lists based on a given advertiser id.</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> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(advertiserId, locationListId, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates a location list. Returns the updated location list if successful.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="create">create(advertiserId, body=None, x__xgafv=None)</code> |
| <pre>Creates a new location list. Returns the newly created location list if successful. |
| |
| Args: |
| advertiserId: string, Required. The ID of the DV360 advertiser to which the location list belongs. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A list of locations used for targeting. |
| "name": "A String", # Output only. The resource name of the location list. |
| "locationListId": "A String", # Output only. The unique ID of the location list. Assigned by the system. |
| "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser the location list belongs to. |
| "displayName": "A String", # Required. The display name of the location list. Must be UTF-8 encoded with a maximum size of 240 bytes. |
| "locationType": "A String", # Required. Immutable. The type of location. All locations in the list will share this type. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A list of locations used for targeting. |
| "name": "A String", # Output only. The resource name of the location list. |
| "locationListId": "A String", # Output only. The unique ID of the location list. Assigned by the system. |
| "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser the location list belongs to. |
| "displayName": "A String", # Required. The display name of the location list. Must be UTF-8 encoded with a maximum size of 240 bytes. |
| "locationType": "A String", # Required. Immutable. The type of location. All locations in the list will share this type. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(advertiserId, locationListId, x__xgafv=None)</code> |
| <pre>Gets a location list. |
| |
| Args: |
| advertiserId: string, Required. The ID of the DV360 advertiser to which the fetched location list belongs. (required) |
| locationListId: string, Required. The ID of the location list to fetch. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A list of locations used for targeting. |
| "name": "A String", # Output only. The resource name of the location list. |
| "locationListId": "A String", # Output only. The unique ID of the location list. Assigned by the system. |
| "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser the location list belongs to. |
| "displayName": "A String", # Required. The display name of the location list. Must be UTF-8 encoded with a maximum size of 240 bytes. |
| "locationType": "A String", # Required. Immutable. The type of location. All locations in the list will share this type. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(advertiserId, filter=None, pageSize=None, pageToken=None, orderBy=None, x__xgafv=None)</code> |
| <pre>Lists location lists based on a given advertiser id. |
| |
| Args: |
| advertiserId: string, Required. The ID of the DV360 advertiser to which the fetched location lists belong. (required) |
| filter: string, Allows filtering by location list fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `locationType` Examples: * All regional location list: `locationType="TARGETING_LOCATION_TYPE_REGIONAL"` * All proximity location list: `locationType="TARGETING_LOCATION_TYPE_PROXIMITY"` |
| 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. |
| 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 `ListLocationLists` method. If not specified, the first page of results will be returned. |
| orderBy: string, Field by which to sort the list. Acceptable values are: * `locationListId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "locationLists": [ # The list of location lists. This list will be absent if empty. |
| { # A list of locations used for targeting. |
| "name": "A String", # Output only. The resource name of the location list. |
| "locationListId": "A String", # Output only. The unique ID of the location list. Assigned by the system. |
| "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser the location list belongs to. |
| "displayName": "A String", # Required. The display name of the location list. Must be UTF-8 encoded with a maximum size of 240 bytes. |
| "locationType": "A String", # Required. Immutable. The type of location. All locations in the list will share this type. |
| }, |
| ], |
| "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 `ListLocationLists` 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> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(advertiserId, locationListId, body=None, updateMask=None, x__xgafv=None)</code> |
| <pre>Updates a location list. Returns the updated location list if successful. |
| |
| Args: |
| advertiserId: string, Required. The ID of the DV360 advertiser to which the location lists belongs. (required) |
| locationListId: string, Output only. The unique ID of the location list. Assigned by the system. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A list of locations used for targeting. |
| "name": "A String", # Output only. The resource name of the location list. |
| "locationListId": "A String", # Output only. The unique ID of the location list. Assigned by the system. |
| "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser the location list belongs to. |
| "displayName": "A String", # Required. The display name of the location list. Must be UTF-8 encoded with a maximum size of 240 bytes. |
| "locationType": "A String", # Required. Immutable. The type of location. All locations in the list will share this type. |
| } |
| |
| updateMask: string, Required. The mask to control which fields to update. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A list of locations used for targeting. |
| "name": "A String", # Output only. The resource name of the location list. |
| "locationListId": "A String", # Output only. The unique ID of the location list. Assigned by the system. |
| "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser the location list belongs to. |
| "displayName": "A String", # Required. The display name of the location list. Must be UTF-8 encoded with a maximum size of 240 bytes. |
| "locationType": "A String", # Required. Immutable. The type of location. All locations in the list will share this type. |
| }</pre> |
| </div> |
| |
| </body></html> |
