Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -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.advertisers.html">advertisers</a> . <a href="displayvideo_v1.advertisers.manualTriggers.html">manualTriggers</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#activate">activate(advertiserId, triggerId, body=None, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Activates a manual trigger. Each activation of the manual trigger must be at least 5 minutes apart, otherwise an error will be returned.</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, body=None, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Creates a new manual trigger. Returns the newly created manual trigger if successful.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#deactivate">deactivate(advertiserId, triggerId, body=None, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Deactivates a manual trigger.</p> |
| 89 | <p class="toc_element"> |
| 90 | <code><a href="#get">get(advertiserId, triggerId, x__xgafv=None)</a></code></p> |
| 91 | <p class="firstline">Gets a manual trigger.</p> |
| 92 | <p class="toc_element"> |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 93 | <code><a href="#list">list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 94 | <p class="firstline">Lists manual triggers that are accessible to the current user for a given advertiser ID. The order is defined by the order_by parameter. A single advertiser_id is required.</p> |
| 95 | <p class="toc_element"> |
| 96 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 97 | <p class="firstline">Retrieves the next page of results.</p> |
| 98 | <p class="toc_element"> |
| 99 | <code><a href="#patch">patch(advertiserId, triggerId, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| 100 | <p class="firstline">Updates a manual trigger. Returns the updated manual trigger if successful.</p> |
| 101 | <h3>Method Details</h3> |
| 102 | <div class="method"> |
| 103 | <code class="details" id="activate">activate(advertiserId, triggerId, body=None, x__xgafv=None)</code> |
| 104 | <pre>Activates a manual trigger. Each activation of the manual trigger must be at least 5 minutes apart, otherwise an error will be returned. |
| 105 | |
| 106 | Args: |
| 107 | advertiserId: string, Required. The ID of the advertiser that the manual trigger belongs. (required) |
| 108 | triggerId: string, Required. The ID of the manual trigger to activate. (required) |
| 109 | body: object, The request body. |
| 110 | The object takes the form of: |
| 111 | |
| 112 | { # Request message for ManualTriggerService.ActivateManualTrigger. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 113 | } |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 114 | |
| 115 | x__xgafv: string, V1 error format. |
| 116 | Allowed values |
| 117 | 1 - v1 error format |
| 118 | 2 - v2 error format |
| 119 | |
| 120 | Returns: |
| 121 | An object of the form: |
| 122 | |
| 123 | { # A single manual trigger in Display & Video 360. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 124 | "activationDurationMinutes": "A String", # Required. The maximum duration of each activation in minutes. Must be between 1 and 360 inclusive. After this duration, the trigger will be automatically deactivated. |
| 125 | "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to. |
| 126 | "displayName": "A String", # Required. The display name of the manual trigger. Must be UTF-8 encoded with a maximum size of 240 bytes. |
| 127 | "latestActivationTime": "A String", # Output only. The timestamp of the trigger's latest activation. |
| 128 | "name": "A String", # Output only. The resource name of the manual trigger. |
| 129 | "state": "A String", # Output only. The state of the manual trigger. Will be set to the `INACTIVE` state upon creation. |
| 130 | "triggerId": "A String", # Output only. The unique ID of the manual trigger. |
| 131 | }</pre> |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 132 | </div> |
| 133 | |
| 134 | <div class="method"> |
| 135 | <code class="details" id="close">close()</code> |
| 136 | <pre>Close httplib2 connections.</pre> |
| 137 | </div> |
| 138 | |
| 139 | <div class="method"> |
| 140 | <code class="details" id="create">create(advertiserId, body=None, x__xgafv=None)</code> |
| 141 | <pre>Creates a new manual trigger. Returns the newly created manual trigger if successful. |
| 142 | |
| 143 | Args: |
| 144 | advertiserId: string, Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to. (required) |
| 145 | body: object, The request body. |
| 146 | The object takes the form of: |
| 147 | |
| 148 | { # A single manual trigger in Display & Video 360. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 149 | "activationDurationMinutes": "A String", # Required. The maximum duration of each activation in minutes. Must be between 1 and 360 inclusive. After this duration, the trigger will be automatically deactivated. |
| 150 | "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to. |
| 151 | "displayName": "A String", # Required. The display name of the manual trigger. Must be UTF-8 encoded with a maximum size of 240 bytes. |
| 152 | "latestActivationTime": "A String", # Output only. The timestamp of the trigger's latest activation. |
| 153 | "name": "A String", # Output only. The resource name of the manual trigger. |
| 154 | "state": "A String", # Output only. The state of the manual trigger. Will be set to the `INACTIVE` state upon creation. |
| 155 | "triggerId": "A String", # Output only. The unique ID of the manual trigger. |
| 156 | } |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 157 | |
| 158 | x__xgafv: string, V1 error format. |
| 159 | Allowed values |
| 160 | 1 - v1 error format |
| 161 | 2 - v2 error format |
| 162 | |
| 163 | Returns: |
| 164 | An object of the form: |
| 165 | |
| 166 | { # A single manual trigger in Display & Video 360. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 167 | "activationDurationMinutes": "A String", # Required. The maximum duration of each activation in minutes. Must be between 1 and 360 inclusive. After this duration, the trigger will be automatically deactivated. |
| 168 | "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to. |
| 169 | "displayName": "A String", # Required. The display name of the manual trigger. Must be UTF-8 encoded with a maximum size of 240 bytes. |
| 170 | "latestActivationTime": "A String", # Output only. The timestamp of the trigger's latest activation. |
| 171 | "name": "A String", # Output only. The resource name of the manual trigger. |
| 172 | "state": "A String", # Output only. The state of the manual trigger. Will be set to the `INACTIVE` state upon creation. |
| 173 | "triggerId": "A String", # Output only. The unique ID of the manual trigger. |
| 174 | }</pre> |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 175 | </div> |
| 176 | |
| 177 | <div class="method"> |
| 178 | <code class="details" id="deactivate">deactivate(advertiserId, triggerId, body=None, x__xgafv=None)</code> |
| 179 | <pre>Deactivates a manual trigger. |
| 180 | |
| 181 | Args: |
| 182 | advertiserId: string, Required. The ID of the advertiser that the manual trigger belongs. (required) |
| 183 | triggerId: string, Required. The ID of the manual trigger to deactivate. (required) |
| 184 | body: object, The request body. |
| 185 | The object takes the form of: |
| 186 | |
| 187 | { # Request message for ManualTriggerService.DeactivateManualTrigger. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 188 | } |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 189 | |
| 190 | x__xgafv: string, V1 error format. |
| 191 | Allowed values |
| 192 | 1 - v1 error format |
| 193 | 2 - v2 error format |
| 194 | |
| 195 | Returns: |
| 196 | An object of the form: |
| 197 | |
| 198 | { # A single manual trigger in Display & Video 360. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 199 | "activationDurationMinutes": "A String", # Required. The maximum duration of each activation in minutes. Must be between 1 and 360 inclusive. After this duration, the trigger will be automatically deactivated. |
| 200 | "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to. |
| 201 | "displayName": "A String", # Required. The display name of the manual trigger. Must be UTF-8 encoded with a maximum size of 240 bytes. |
| 202 | "latestActivationTime": "A String", # Output only. The timestamp of the trigger's latest activation. |
| 203 | "name": "A String", # Output only. The resource name of the manual trigger. |
| 204 | "state": "A String", # Output only. The state of the manual trigger. Will be set to the `INACTIVE` state upon creation. |
| 205 | "triggerId": "A String", # Output only. The unique ID of the manual trigger. |
| 206 | }</pre> |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 207 | </div> |
| 208 | |
| 209 | <div class="method"> |
| 210 | <code class="details" id="get">get(advertiserId, triggerId, x__xgafv=None)</code> |
| 211 | <pre>Gets a manual trigger. |
| 212 | |
| 213 | Args: |
| 214 | advertiserId: string, Required. The ID of the advertiser this manual trigger belongs to. (required) |
| 215 | triggerId: string, Required. The ID of the manual trigger to fetch. (required) |
| 216 | x__xgafv: string, V1 error format. |
| 217 | Allowed values |
| 218 | 1 - v1 error format |
| 219 | 2 - v2 error format |
| 220 | |
| 221 | Returns: |
| 222 | An object of the form: |
| 223 | |
| 224 | { # A single manual trigger in Display & Video 360. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 225 | "activationDurationMinutes": "A String", # Required. The maximum duration of each activation in minutes. Must be between 1 and 360 inclusive. After this duration, the trigger will be automatically deactivated. |
| 226 | "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to. |
| 227 | "displayName": "A String", # Required. The display name of the manual trigger. Must be UTF-8 encoded with a maximum size of 240 bytes. |
| 228 | "latestActivationTime": "A String", # Output only. The timestamp of the trigger's latest activation. |
| 229 | "name": "A String", # Output only. The resource name of the manual trigger. |
| 230 | "state": "A String", # Output only. The state of the manual trigger. Will be set to the `INACTIVE` state upon creation. |
| 231 | "triggerId": "A String", # Output only. The unique ID of the manual trigger. |
| 232 | }</pre> |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 233 | </div> |
| 234 | |
| 235 | <div class="method"> |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 236 | <code class="details" id="list">list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 237 | <pre>Lists manual triggers that are accessible to the current user for a given advertiser ID. The order is defined by the order_by parameter. A single advertiser_id is required. |
| 238 | |
| 239 | Args: |
| 240 | advertiserId: string, Required. The ID of the advertiser that the fetched manual triggers belong to. (required) |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 241 | filter: string, Allows filtering by manual trigger properties. 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: - `displayName` - `state` Examples: * All active manual triggers under an advertiser: `state="ACTIVE"` The length of this field should be no more than 500 characters. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 242 | orderBy: string, Field by which to sort the list. Acceptable values are: * `displayName` (default) * `state` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`. |
| 243 | pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. |
| 244 | 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 `ListManualTriggers` method. If not specified, the first page of results will be returned. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 245 | x__xgafv: string, V1 error format. |
| 246 | Allowed values |
| 247 | 1 - v1 error format |
| 248 | 2 - v2 error format |
| 249 | |
| 250 | Returns: |
| 251 | An object of the form: |
| 252 | |
| 253 | { |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 254 | "manualTriggers": [ # The list of manual triggers. This list will be absent if empty. |
| 255 | { # A single manual trigger in Display & Video 360. |
| 256 | "activationDurationMinutes": "A String", # Required. The maximum duration of each activation in minutes. Must be between 1 and 360 inclusive. After this duration, the trigger will be automatically deactivated. |
| 257 | "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to. |
| 258 | "displayName": "A String", # Required. The display name of the manual trigger. Must be UTF-8 encoded with a maximum size of 240 bytes. |
| 259 | "latestActivationTime": "A String", # Output only. The timestamp of the trigger's latest activation. |
| 260 | "name": "A String", # Output only. The resource name of the manual trigger. |
| 261 | "state": "A String", # Output only. The state of the manual trigger. Will be set to the `INACTIVE` state upon creation. |
| 262 | "triggerId": "A String", # Output only. The unique ID of the manual trigger. |
| 263 | }, |
| 264 | ], |
| 265 | "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 `ListManualTriggers` method to retrieve the next page of results. |
| 266 | }</pre> |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 267 | </div> |
| 268 | |
| 269 | <div class="method"> |
| 270 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 271 | <pre>Retrieves the next page of results. |
| 272 | |
| 273 | Args: |
| 274 | previous_request: The request for the previous page. (required) |
| 275 | previous_response: The response from the request for the previous page. (required) |
| 276 | |
| 277 | Returns: |
| 278 | A request object that you can call 'execute()' on to request the next |
| 279 | page. Returns None if there are no more items in the collection. |
| 280 | </pre> |
| 281 | </div> |
| 282 | |
| 283 | <div class="method"> |
| 284 | <code class="details" id="patch">patch(advertiserId, triggerId, body=None, updateMask=None, x__xgafv=None)</code> |
| 285 | <pre>Updates a manual trigger. Returns the updated manual trigger if successful. |
| 286 | |
| 287 | Args: |
| 288 | advertiserId: string, Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to. (required) |
| 289 | triggerId: string, Output only. The unique ID of the manual trigger. (required) |
| 290 | body: object, The request body. |
| 291 | The object takes the form of: |
| 292 | |
| 293 | { # A single manual trigger in Display & Video 360. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 294 | "activationDurationMinutes": "A String", # Required. The maximum duration of each activation in minutes. Must be between 1 and 360 inclusive. After this duration, the trigger will be automatically deactivated. |
| 295 | "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to. |
| 296 | "displayName": "A String", # Required. The display name of the manual trigger. Must be UTF-8 encoded with a maximum size of 240 bytes. |
| 297 | "latestActivationTime": "A String", # Output only. The timestamp of the trigger's latest activation. |
| 298 | "name": "A String", # Output only. The resource name of the manual trigger. |
| 299 | "state": "A String", # Output only. The state of the manual trigger. Will be set to the `INACTIVE` state upon creation. |
| 300 | "triggerId": "A String", # Output only. The unique ID of the manual trigger. |
| 301 | } |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 302 | |
| 303 | updateMask: string, Required. The mask to control which fields to update. |
| 304 | x__xgafv: string, V1 error format. |
| 305 | Allowed values |
| 306 | 1 - v1 error format |
| 307 | 2 - v2 error format |
| 308 | |
| 309 | Returns: |
| 310 | An object of the form: |
| 311 | |
| 312 | { # A single manual trigger in Display & Video 360. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 313 | "activationDurationMinutes": "A String", # Required. The maximum duration of each activation in minutes. Must be between 1 and 360 inclusive. After this duration, the trigger will be automatically deactivated. |
| 314 | "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to. |
| 315 | "displayName": "A String", # Required. The display name of the manual trigger. Must be UTF-8 encoded with a maximum size of 240 bytes. |
| 316 | "latestActivationTime": "A String", # Output only. The timestamp of the trigger's latest activation. |
| 317 | "name": "A String", # Output only. The resource name of the manual trigger. |
| 318 | "state": "A String", # Output only. The state of the manual trigger. Will be set to the `INACTIVE` state upon creation. |
| 319 | "triggerId": "A String", # Output only. The unique ID of the manual trigger. |
| 320 | }</pre> |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 321 | </div> |
| 322 | |
| 323 | </body></html> |