1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
|
<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.manualTriggers.html">manualTriggers</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#activate">activate(advertiserId, triggerId, body=None, x__xgafv=None)</a></code></p>
<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. **Warning:** Line Items using manual triggers no longer serve in Display & Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</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 manual trigger. Returns the newly created manual trigger if successful. **Warning:** Line Items using manual triggers no longer serve in Display & Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.</p>
<p class="toc_element">
<code><a href="#deactivate">deactivate(advertiserId, triggerId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deactivates a manual trigger. **Warning:** Line Items using manual triggers no longer serve in Display & Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.</p>
<p class="toc_element">
<code><a href="#get">get(advertiserId, triggerId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a manual trigger. **Warning:** Line Items using manual triggers no longer serve in Display & Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.</p>
<p class="toc_element">
<code><a href="#list">list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<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. **Warning:** Line Items using manual triggers no longer serve in Display & Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(advertiserId, triggerId, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a manual trigger. Returns the updated manual trigger if successful. **Warning:** Line Items using manual triggers no longer serve in Display & Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="activate">activate(advertiserId, triggerId, body=None, x__xgafv=None)</code>
<pre>Activates a manual trigger. Each activation of the manual trigger must be at least 5 minutes apart, otherwise an error will be returned. **Warning:** Line Items using manual triggers no longer serve in Display & Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.
Args:
advertiserId: string, Required. The ID of the advertiser that the manual trigger belongs. (required)
triggerId: string, Required. The ID of the manual trigger to activate. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for ManualTriggerService.ActivateManualTrigger.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A single manual trigger in Display & Video 360. **Warning:** Line Items using manual triggers no longer serve in Display & Video 360. This resource will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.
"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.
"advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.
"displayName": "A String", # Required. The display name of the manual trigger. Must be UTF-8 encoded with a maximum size of 240 bytes.
"latestActivationTime": "A String", # Output only. The timestamp of the trigger's latest activation.
"name": "A String", # Output only. The resource name of the manual trigger.
"state": "A String", # Output only. The state of the manual trigger. Will be set to the `INACTIVE` state upon creation.
"triggerId": "A String", # Output only. The unique ID of the manual trigger.
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(advertiserId, body=None, x__xgafv=None)</code>
<pre>Creates a new manual trigger. Returns the newly created manual trigger if successful. **Warning:** Line Items using manual triggers no longer serve in Display & Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.
Args:
advertiserId: string, Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to. (required)
body: object, The request body.
The object takes the form of:
{ # A single manual trigger in Display & Video 360. **Warning:** Line Items using manual triggers no longer serve in Display & Video 360. This resource will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.
"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.
"advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.
"displayName": "A String", # Required. The display name of the manual trigger. Must be UTF-8 encoded with a maximum size of 240 bytes.
"latestActivationTime": "A String", # Output only. The timestamp of the trigger's latest activation.
"name": "A String", # Output only. The resource name of the manual trigger.
"state": "A String", # Output only. The state of the manual trigger. Will be set to the `INACTIVE` state upon creation.
"triggerId": "A String", # Output only. The unique ID of the manual trigger.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A single manual trigger in Display & Video 360. **Warning:** Line Items using manual triggers no longer serve in Display & Video 360. This resource will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.
"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.
"advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.
"displayName": "A String", # Required. The display name of the manual trigger. Must be UTF-8 encoded with a maximum size of 240 bytes.
"latestActivationTime": "A String", # Output only. The timestamp of the trigger's latest activation.
"name": "A String", # Output only. The resource name of the manual trigger.
"state": "A String", # Output only. The state of the manual trigger. Will be set to the `INACTIVE` state upon creation.
"triggerId": "A String", # Output only. The unique ID of the manual trigger.
}</pre>
</div>
<div class="method">
<code class="details" id="deactivate">deactivate(advertiserId, triggerId, body=None, x__xgafv=None)</code>
<pre>Deactivates a manual trigger. **Warning:** Line Items using manual triggers no longer serve in Display & Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.
Args:
advertiserId: string, Required. The ID of the advertiser that the manual trigger belongs. (required)
triggerId: string, Required. The ID of the manual trigger to deactivate. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for ManualTriggerService.DeactivateManualTrigger.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A single manual trigger in Display & Video 360. **Warning:** Line Items using manual triggers no longer serve in Display & Video 360. This resource will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.
"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.
"advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.
"displayName": "A String", # Required. The display name of the manual trigger. Must be UTF-8 encoded with a maximum size of 240 bytes.
"latestActivationTime": "A String", # Output only. The timestamp of the trigger's latest activation.
"name": "A String", # Output only. The resource name of the manual trigger.
"state": "A String", # Output only. The state of the manual trigger. Will be set to the `INACTIVE` state upon creation.
"triggerId": "A String", # Output only. The unique ID of the manual trigger.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(advertiserId, triggerId, x__xgafv=None)</code>
<pre>Gets a manual trigger. **Warning:** Line Items using manual triggers no longer serve in Display & Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.
Args:
advertiserId: string, Required. The ID of the advertiser this manual trigger belongs to. (required)
triggerId: string, Required. The ID of the manual trigger 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 single manual trigger in Display & Video 360. **Warning:** Line Items using manual triggers no longer serve in Display & Video 360. This resource will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.
"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.
"advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.
"displayName": "A String", # Required. The display name of the manual trigger. Must be UTF-8 encoded with a maximum size of 240 bytes.
"latestActivationTime": "A String", # Output only. The timestamp of the trigger's latest activation.
"name": "A String", # Output only. The resource name of the manual trigger.
"state": "A String", # Output only. The state of the manual trigger. Will be set to the `INACTIVE` state upon creation.
"triggerId": "A String", # Output only. The unique ID of the manual trigger.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<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. **Warning:** Line Items using manual triggers no longer serve in Display & Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.
Args:
advertiserId: string, Required. The ID of the advertiser that the fetched manual triggers belong to. (required)
filter: string, Allows filtering by manual trigger 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}`. * All fields must use the `EQUALS (=)` operator. 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. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
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`.
pageSize: integer, Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"manualTriggers": [ # The list of manual triggers. This list will be absent if empty.
{ # A single manual trigger in Display & Video 360. **Warning:** Line Items using manual triggers no longer serve in Display & Video 360. This resource will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.
"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.
"advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.
"displayName": "A String", # Required. The display name of the manual trigger. Must be UTF-8 encoded with a maximum size of 240 bytes.
"latestActivationTime": "A String", # Output only. The timestamp of the trigger's latest activation.
"name": "A String", # Output only. The resource name of the manual trigger.
"state": "A String", # Output only. The state of the manual trigger. Will be set to the `INACTIVE` state upon creation.
"triggerId": "A String", # Output only. The unique ID of the manual trigger.
},
],
"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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</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, triggerId, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates a manual trigger. Returns the updated manual trigger if successful. **Warning:** Line Items using manual triggers no longer serve in Display & Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.
Args:
advertiserId: string, Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to. (required)
triggerId: string, Output only. The unique ID of the manual trigger. (required)
body: object, The request body.
The object takes the form of:
{ # A single manual trigger in Display & Video 360. **Warning:** Line Items using manual triggers no longer serve in Display & Video 360. This resource will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.
"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.
"advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.
"displayName": "A String", # Required. The display name of the manual trigger. Must be UTF-8 encoded with a maximum size of 240 bytes.
"latestActivationTime": "A String", # Output only. The timestamp of the trigger's latest activation.
"name": "A String", # Output only. The resource name of the manual trigger.
"state": "A String", # Output only. The state of the manual trigger. Will be set to the `INACTIVE` state upon creation.
"triggerId": "A String", # Output only. The unique ID of the manual trigger.
}
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 single manual trigger in Display & Video 360. **Warning:** Line Items using manual triggers no longer serve in Display & Video 360. This resource will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.
"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.
"advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.
"displayName": "A String", # Required. The display name of the manual trigger. Must be UTF-8 encoded with a maximum size of 240 bytes.
"latestActivationTime": "A String", # Output only. The timestamp of the trigger's latest activation.
"name": "A String", # Output only. The resource name of the manual trigger.
"state": "A String", # Output only. The state of the manual trigger. Will be set to the `INACTIVE` state upon creation.
"triggerId": "A String", # Output only. The unique ID of the manual trigger.
}</pre>
</div>
</body></html>
|
