Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3e17f8990db54bec16c48c319072799a14f5a53f / . / docs / dyn / doubleclickbidmanager_v1.lineitems.html
blob: d36357d48d8a1a82743dbd5dca25ff1c3833d6ce [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[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="doubleclickbidmanager_v1.html">DoubleClick Bid Manager API</a> . <a href="doubleclickbidmanager_v1.lineitems.html">lineitems</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>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]80<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]81 <code><a href="#downloadlineitems">downloadlineitems(body=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Retrieves line items in CSV format. YouTube & partners line items are not supported.</p>
83<p class="toc_element">
84 <code><a href="#uploadlineitems">uploadlineitems(body=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Uploads line items in CSV format. YouTube & partners line items are not supported.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]86<h3>Method Details</h3>
87<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]88 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90</div>
91
92<div class="method">
93 <code class="details" id="downloadlineitems">downloadlineitems(body=None, x__xgafv=None)</code>
94 <pre>Retrieves line items in CSV format. YouTube &amp; partners line items are not supported.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]95
96Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]97 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]98 The object takes the form of:
99
100{ # Request to fetch stored line items.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]101 &quot;filterType&quot;: &quot;A String&quot;, # Filter type used to filter line items to fetch.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]102 &quot;fileSpec&quot;: &quot;A String&quot;, # File specification (column names, types, order) in which the line items will be returned. Default to EWF.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]103 &quot;format&quot;: &quot;A String&quot;, # Format in which the line items will be returned. Default to CSV.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]104 &quot;filterIds&quot;: [ # Ids of the specified filter type used to filter line items to fetch. If omitted, all the line items will be returned.
105 &quot;A String&quot;,
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]106 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]107 }
108
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]109 x__xgafv: string, V1 error format.
110 Allowed values
111 1 - v1 error format
112 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]113
114Returns:
115 An object of the form:
116
117 { # Download line items response.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]118 &quot;lineItems&quot;: &quot;A String&quot;, # Retrieved line items in CSV format. For more information about file formats, see Entity Write File Format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]119 }</pre>
120</div>
121
122<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]123 <code class="details" id="uploadlineitems">uploadlineitems(body=None, x__xgafv=None)</code>
124 <pre>Uploads line items in CSV format. YouTube &amp; partners line items are not supported.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]125
126Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]127 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]128 The object takes the form of:
129
130{ # Request to upload line items.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]131 &quot;lineItems&quot;: &quot;A String&quot;, # Line items in CSV to upload. Refer to Entity Write File Format for more information on file format.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]132 &quot;dryRun&quot;: True or False, # Set to true to get upload status without actually persisting the line items.
133 &quot;format&quot;: &quot;A String&quot;, # Format the line items are in. Default to CSV.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]134 }
135
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]136 x__xgafv: string, V1 error format.
137 Allowed values
138 1 - v1 error format
139 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]140
141Returns:
142 An object of the form:
143
144 { # Upload line items response.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]145 &quot;uploadStatus&quot;: { # Represents the status of upload. # Status of upload.
146 &quot;errors&quot;: [ # Reasons why upload can&#x27;t be completed.
147 &quot;A String&quot;,
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]148 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]149 &quot;rowStatus&quot;: [ # Per-row upload status.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]150 { # Represents the upload status of a row in the request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]151 &quot;entityId&quot;: &quot;A String&quot;, # Entity Id.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]152 &quot;persisted&quot;: True or False, # Whether the entity is persisted.
153 &quot;changed&quot;: True or False, # Whether the stored entity is changed as a result of upload.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]154 &quot;entityName&quot;: &quot;A String&quot;, # Entity name.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]155 &quot;rowNumber&quot;: 42, # Row number.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]156 &quot;errors&quot;: [ # Reasons why the entity can&#x27;t be uploaded.
157 &quot;A String&quot;,
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]158 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]159 },
160 ],
161 },
162 }</pre>
163</div>
164
165</body></html>