blob: d4fdc48fed71eba860cf825b802920592f18c4e5 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<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">
78 <code><a href="#downloadlineitems">downloadlineitems(body)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070079<p class="firstline">Retrieves line items in CSV format. TrueView line items are not supported.</p>
John Asmuth614db982014-04-24 15:46:26 -040080<p class="toc_element">
81 <code><a href="#uploadlineitems">uploadlineitems(body)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070082<p class="firstline">Uploads line items in CSV format. TrueView line items are not supported.</p>
John Asmuth614db982014-04-24 15:46:26 -040083<h3>Method Details</h3>
84<div class="method">
85 <code class="details" id="downloadlineitems">downloadlineitems(body)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070086 <pre>Retrieves line items in CSV format. TrueView line items are not supported.
John Asmuth614db982014-04-24 15:46:26 -040087
88Args:
89 body: object, The request body. (required)
90 The object takes the form of:
91
92{ # Request to fetch stored line items.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080093 "fileSpec": "A String", # File specification (column names, types, order) in which the line items will be returned. Default to EWF.
John Asmuth614db982014-04-24 15:46:26 -040094 "filterType": "A String", # Filter type used to filter line items to fetch.
95 "filterIds": [ # Ids of the specified filter type used to filter line items to fetch. If omitted, all the line items will be returned.
96 "A String",
97 ],
98 "format": "A String", # Format in which the line items will be returned. Default to CSV.
99 }
100
101
102Returns:
103 An object of the form:
104
105 { # Download line items response.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700106 "lineItems": "A String", # Retrieved line items in CSV format. For more information about file formats, see Entity Write File Format.
John Asmuth614db982014-04-24 15:46:26 -0400107 }</pre>
108</div>
109
110<div class="method">
111 <code class="details" id="uploadlineitems">uploadlineitems(body)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700112 <pre>Uploads line items in CSV format. TrueView line items are not supported.
John Asmuth614db982014-04-24 15:46:26 -0400113
114Args:
115 body: object, The request body. (required)
116 The object takes the form of:
117
118{ # Request to upload line items.
119 "lineItems": "A String", # Line items in CSV to upload. Refer to Entity Write File Format for more information on file format.
120 "dryRun": True or False, # Set to true to get upload status without actually persisting the line items.
121 "format": "A String", # Format the line items are in. Default to CSV.
122 }
123
124
125Returns:
126 An object of the form:
127
128 { # Upload line items response.
129 "uploadStatus": { # Represents the status of upload. # Status of upload.
130 "errors": [ # Reasons why upload can't be completed.
131 "A String",
132 ],
133 "rowStatus": [ # Per-row upload status.
134 { # Represents the upload status of a row in the request.
135 "errors": [ # Reasons why the entity can't be uploaded.
136 "A String",
137 ],
138 "entityName": "A String", # Entity name.
139 "changed": True or False, # Whether the stored entity is changed as a result of upload.
140 "rowNumber": 42, # Row number.
141 "persisted": True or False, # Whether the entity is persisted.
142 "entityId": "A String", # Entity Id.
143 },
144 ],
145 },
146 }</pre>
147</div>
148
149</body></html>