Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d059ad881c7ae58c67931c48788d0bd7343ab16c / . / docs / dyn / displayvideo_v1.combinedAudiences.html
blob: c9a3434073f595b6971443fffff68bea98918d40 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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.combinedAudiences.html">combinedAudiences</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(combinedAudienceId, partnerId=None, advertiserId=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Gets a combined audience.</p>
80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]81 <code><a href="#list">list(pageToken=None, advertiserId=None, orderBy=None, filter=None, partnerId=None, pageSize=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Lists combined audiences. The order is defined by the order_by parameter.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
88 <code class="details" id="get">get(combinedAudienceId, partnerId=None, advertiserId=None, x__xgafv=None)</code>
89 <pre>Gets a combined audience.
90
91Args:
92 combinedAudienceId: string, Required. The ID of the combined audience to fetch. (required)
93 partnerId: string, The ID of the partner that has access to the fetched combined audience.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]94 advertiserId: string, The ID of the advertiser that has access to the fetched combined audience.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]95 x__xgafv: string, V1 error format.
96 Allowed values
97 1 - v1 error format
98 2 - v2 error format
99
100Returns:
101 An object of the form:
102
103 { # Describes a combined audience resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]104 &quot;combinedAudienceId&quot;: &quot;A String&quot;, # Output only. The unique ID of the combined audience. Assigned by the system.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]105 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the combined audience. .
106 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the combined audience.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]107 }</pre>
108</div>
109
110<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]111 <code class="details" id="list">list(pageToken=None, advertiserId=None, orderBy=None, filter=None, partnerId=None, pageSize=None, x__xgafv=None)</code>
112 <pre>Lists combined audiences. The order is defined by the order_by parameter.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]113
114Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]115 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 `ListCombinedAudiences` method. If not specified, the first page of results will be returned.
116 advertiserId: string, The ID of the advertiser that has access to the fetched combined audiences.
117 orderBy: string, Field by which to sort the list. Acceptable values are: * `combinedAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix &quot;desc&quot; should be added to the field name. Example: `displayName desc`.
118 filter: string, Allows filtering by combined audience fields. Supported syntax: * Filter expressions for combined audiences currently can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All combined audiences for which the display name contains &quot;Google&quot;: `displayName : &quot;Google&quot;`. The length of this field should be no more than 500 characters.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]119 partnerId: string, The ID of the partner that has access to the fetched combined audiences.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]120 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]121 x__xgafv: string, V1 error format.
122 Allowed values
123 1 - v1 error format
124 2 - v2 error format
125
126Returns:
127 An object of the form:
128
129 {
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]130 &quot;combinedAudiences&quot;: [ # The list of combined audiences. This list will be absent if empty.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]131 { # Describes a combined audience resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]132 &quot;combinedAudienceId&quot;: &quot;A String&quot;, # Output only. The unique ID of the combined audience. Assigned by the system.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]133 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the combined audience. .
134 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the combined audience.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]135 },
136 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]137 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCombinedAudiences` method to retrieve the next page of results.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]138 }</pre>
139</div>
140
141<div class="method">
142 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
143 <pre>Retrieves the next page of results.
144
145Args:
146 previous_request: The request for the previous page. (required)
147 previous_response: The response from the request for the previous page. (required)
148
149Returns:
150 A request object that you can call &#x27;execute()&#x27; on to request the next
151 page. Returns None if there are no more items in the collection.
152 </pre>
153</div>
154
155</body></html>