Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b6971b0405ba59d905b84fa5fc8e27e12d29b70c / . / docs / dyn / displayvideo_v1.googleAudiences.html
blob: 14f438218d698a2cfca1b612c4241e5333e75539 [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.googleAudiences.html">googleAudiences</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]81 <code><a href="#get">get(googleAudienceId, partnerId=None, advertiserId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]82<p class="firstline">Gets a Google audience.</p>
83<p class="toc_element">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]84 <code><a href="#list">list(pageToken=None, filter=None, pageSize=None, partnerId=None, advertiserId=None, orderBy=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]85<p class="firstline">Lists Google audiences. The order is defined by the order_by parameter.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<h3>Method Details</h3>
90<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93</div>
94
95<div class="method">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]96 <code class="details" id="get">get(googleAudienceId, partnerId=None, advertiserId=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]97 <pre>Gets a Google audience.
98
99Args:
100 googleAudienceId: string, Required. The ID of the Google audience to fetch. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]101 partnerId: string, The ID of the partner that has access to the fetched Google audience.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]102 advertiserId: string, The ID of the advertiser that has access to the fetched Google audience.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]103 x__xgafv: string, V1 error format.
104 Allowed values
105 1 - v1 error format
106 2 - v2 error format
107
108Returns:
109 An object of the form:
110
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]111 { # Describes a Google audience resource. Includes Google audience lists.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]112 &quot;googleAudienceType&quot;: &quot;A String&quot;, # Output only. The type of Google audience. .
113 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the Google audience. .
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]114 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the google audience.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]115 &quot;googleAudienceId&quot;: &quot;A String&quot;, # Output only. The unique ID of the Google audience. Assigned by the system.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]116 }</pre>
117</div>
118
119<div class="method">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]120 <code class="details" id="list">list(pageToken=None, filter=None, pageSize=None, partnerId=None, advertiserId=None, orderBy=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]121 <pre>Lists Google audiences. The order is defined by the order_by parameter.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]122
123Args:
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]124 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 `ListGoogleAudiences` method. If not specified, the first page of results will be returned.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]125 filter: string, Allows filtering by Google audience fields. Supported syntax: * Filter expressions for Google 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 Google 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 Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]126 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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]127 partnerId: string, The ID of the partner that has access to the fetched Google audiences.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]128 advertiserId: string, The ID of the advertiser that has access to the fetched Google audiences.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]129 orderBy: string, Field by which to sort the list. Acceptable values are: * `googleAudienceId` (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`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]130 x__xgafv: string, V1 error format.
131 Allowed values
132 1 - v1 error format
133 2 - v2 error format
134
135Returns:
136 An object of the form:
137
138 {
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]139 &quot;googleAudiences&quot;: [ # The list of Google audiences. This list will be absent if empty.
140 { # Describes a Google audience resource. Includes Google audience lists.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]141 &quot;googleAudienceType&quot;: &quot;A String&quot;, # Output only. The type of Google audience. .
142 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the Google audience. .
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]143 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the google audience.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]144 &quot;googleAudienceId&quot;: &quot;A String&quot;, # Output only. The unique ID of the Google audience. Assigned by the system.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]145 },
146 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]147 &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 `ListGoogleAudiences` method to retrieve the next page of results.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]148 }</pre>
149</div>
150
151<div class="method">
152 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
153 <pre>Retrieves the next page of results.
154
155Args:
156 previous_request: The request for the previous page. (required)
157 previous_response: The response from the request for the previous page. (required)
158
159Returns:
160 A request object that you can call &#x27;execute()&#x27; on to request the next
161 page. Returns None if there are no more items in the collection.
162 </pre>
163</div>
164
165</body></html>