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
|
<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_v4.html">Display & Video 360 API</a> . <a href="displayvideo_v4.floodlightGroups.html">floodlightGroups</a> . <a href="displayvideo_v4.floodlightGroups.floodlightActivities.html">floodlightActivities</a></h1>
<h2>Instance Methods</h2>
<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="#get">get(floodlightGroupId, floodlightActivityId, partnerId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a Floodlight activity.</p>
<p class="toc_element">
<code><a href="#list">list(floodlightGroupId, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Floodlight activities in a Floodlight group.</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>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(floodlightGroupId, floodlightActivityId, partnerId=None, x__xgafv=None)</code>
<pre>Gets a Floodlight activity.
Args:
floodlightGroupId: string, Required. The ID of the parent Floodlight group to which the requested Floodlight activity belongs. (required)
floodlightActivityId: string, Required. The ID of the Floodlight activity to fetch. (required)
partnerId: string, Required. The ID of the partner through which the Floodlight activity is being accessed.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A single Floodlight activity.
"advertiserIds": [ # Output only. IDs of the advertisers that have access to the parent Floodlight group. Only advertisers under the provided partner ID will be listed in this field.
"A String",
],
"displayName": "A String", # Required. The display name of the Floodlight activity.
"floodlightActivityId": "A String", # Output only. The unique ID of the Floodlight activity. Assigned by the system.
"floodlightGroupId": "A String", # Required. Immutable. The ID of the parent Floodlight group.
"name": "A String", # Output only. The resource name of the Floodlight activity.
"remarketingConfigs": [ # Output only. A list of configuration objects designating whether remarketing for this Floodlight Activity is enabled and available for a specifc advertiser. If enabled, this Floodlight Activity generates a remarketing user list that is able to be used in targeting under the advertiser.
{ # Settings that control the whether remarketing is enabled for the given identified advertiser.
"advertiserId": "A String", # Output only. The ID of the advertiser.
"remarketingEnabled": True or False, # Output only. Whether the Floodlight activity remarketing user list is available to the identified advertiser.
},
],
"servingStatus": "A String", # Optional. Whether the Floodlight activity is served.
"sslRequired": True or False, # Output only. Whether tags are required to be compliant.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(floodlightGroupId, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)</code>
<pre>Lists Floodlight activities in a Floodlight group.
Args:
floodlightGroupId: string, Required. The ID of the parent Floodlight group to which the requested Floodlight activities belong. (required)
orderBy: string, Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `floodlightActivityId` 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`.
pageSize: integer, Optional. 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.
pageToken: string, Optional. 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 `ListFloodlightActivities` method. If not specified, the first page of results will be returned.
partnerId: string, Required. The ID of the partner through which the Floodlight activities are being accessed.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"floodlightActivities": [ # The list of Floodlight activities. This list will be absent if empty.
{ # A single Floodlight activity.
"advertiserIds": [ # Output only. IDs of the advertisers that have access to the parent Floodlight group. Only advertisers under the provided partner ID will be listed in this field.
"A String",
],
"displayName": "A String", # Required. The display name of the Floodlight activity.
"floodlightActivityId": "A String", # Output only. The unique ID of the Floodlight activity. Assigned by the system.
"floodlightGroupId": "A String", # Required. Immutable. The ID of the parent Floodlight group.
"name": "A String", # Output only. The resource name of the Floodlight activity.
"remarketingConfigs": [ # Output only. A list of configuration objects designating whether remarketing for this Floodlight Activity is enabled and available for a specifc advertiser. If enabled, this Floodlight Activity generates a remarketing user list that is able to be used in targeting under the advertiser.
{ # Settings that control the whether remarketing is enabled for the given identified advertiser.
"advertiserId": "A String", # Output only. The ID of the advertiser.
"remarketingEnabled": True or False, # Output only. Whether the Floodlight activity remarketing user list is available to the identified advertiser.
},
],
"servingStatus": "A String", # Optional. Whether the Floodlight activity is served.
"sslRequired": True or False, # Output only. Whether tags are required to be compliant.
},
],
"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 `ListFloodlightActivities` 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>
</body></html>
|
