blob: 46bcbb307da1de0af1fc24ac6544fb1a0278af2f [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -07001<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.sdfdownloadtasks.html">sdfdownloadtasks</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="displayvideo_v1.sdfdownloadtasks.operations.html">operations()</a></code>
79</p>
80<p class="firstline">Returns the operations Resource.</p>
81
82<p class="toc_element">
83 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
84<p class="firstline">Creates an SDF Download Task. Returns an</p>
85<h3>Method Details</h3>
86<div class="method">
87 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
88 <pre>Creates an SDF Download Task. Returns an
89Operation.
90
91An SDF Download Task is a long-running, asynchronous operation. The
92metadata type of this operation is
93SdfDownloadTaskMetadata. If the request is successful, the
94response type of the operation is
95SdfDownloadTask. The response will not include the download files,
96which must be retrieved with
97media.download. The state of
98operation can be retrieved with
99sdfdownloadtask.operations.get.
100
101Any errors can be found in the
102error.message. Note
103that error.details is expected to be
104empty.
105
106Args:
107 body: object, The request body.
108 The object takes the form of:
109
110{ # Request message for [SdfDownloadTaskService.CreateSdfDownloadTask].
111 &quot;advertiserId&quot;: &quot;A String&quot;, # The ID of the advertiser to download SDF for.
112 &quot;parentEntityFilter&quot;: { # A filtering option that filters on selected file types belonging to a chosen # Filters on selected file types. The entities in each file are filtered
113 # by a chosen set of filter entities. The filter entities must be the same
114 # type as, or a parent type of, the selected file types.
115 # set of filter entities.
116 &quot;fileType&quot;: [ # Required. File types that will be returned.
117 &quot;A String&quot;,
118 ],
119 &quot;filterType&quot;: &quot;A String&quot;, # Required. Filter type used to filter fetched entities.
120 &quot;filterIds&quot;: [ # The IDs of the specified filter type. This is used to filter entities to
121 # fetch. If filter type is not `FILTER_TYPE_NONE`, at least one ID must be
122 # specified.
123 &quot;A String&quot;,
124 ],
125 },
126 &quot;idFilter&quot;: { # A filtering option that filters entities by their entity IDs. # Filters on entities by their entity IDs.
Bu Sun Kim65020912020-05-20 12:08:20 -0700127 &quot;adGroupAdIds&quot;: [ # TrueView Ads to download by ID. All IDs must belong to the same
128 # Advertiser or
129 # Partner specified in
130 # CreateSdfDownloadTaskRequest.
131 &quot;A String&quot;,
132 ],
133 &quot;adGroupIds&quot;: [ # TrueView Ad Groups to download by ID. All IDs must belong to the same
134 # Advertiser or
135 # Partner specified in
136 # CreateSdfDownloadTaskRequest.
137 &quot;A String&quot;,
138 ],
139 &quot;campaignIds&quot;: [ # Campaigns to download by ID. All IDs must belong to the same
140 # Advertiser or
141 # Partner specified in
142 # CreateSdfDownloadTaskRequest.
143 &quot;A String&quot;,
144 ],
145 &quot;insertionOrderIds&quot;: [ # Insertion Orders to download by ID. All IDs must belong to the same
146 # Advertiser or
147 # Partner specified in
148 # CreateSdfDownloadTaskRequest.
149 &quot;A String&quot;,
150 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700151 &quot;mediaProductIds&quot;: [ # Media Products to download by ID. All IDs must belong to the same
152 # Advertiser or
153 # Partner specified in
154 # CreateSdfDownloadTaskRequest.
155 &quot;A String&quot;,
156 ],
157 &quot;lineItemIds&quot;: [ # Line Items to download by ID. All IDs must belong to the same
158 # Advertiser or
159 # Partner specified in
160 # CreateSdfDownloadTaskRequest.
161 &quot;A String&quot;,
162 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700163 },
164 &quot;partnerId&quot;: &quot;A String&quot;, # The ID of the partner to download SDF for.
165 &quot;version&quot;: &quot;A String&quot;, # Required. The SDF version of the downloaded file. If set to
166 # `SDF_VERSION_UNSPECIFIED`, this will default to the version specified by
167 # the advertiser or partner identified by `root_id`. An advertiser inherits
168 # its SDF version from its partner unless configured otherwise.
169 &quot;inventorySourceFilter&quot;: { # A filtering option for filtering on Inventory Source entities. # Filters on Inventory Sources by their IDs.
170 &quot;inventorySourceIds&quot;: [ # Inventory Sources to download by ID. All IDs must belong to the same
171 # Advertiser or
172 # Partner specified in
173 # CreateSdfDownloadTaskRequest. Leave empty to download all Inventory
174 # Sources for the selected Advertiser or Partner.
175 &quot;A String&quot;,
176 ],
177 },
178 }
179
180 x__xgafv: string, V1 error format.
181 Allowed values
182 1 - v1 error format
183 2 - v2 error format
184
185Returns:
186 An object of the form:
187
188 { # This resource represents a long-running operation that is the result of a
189 # network API call.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700190 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
191 # If `true`, the operation is completed, and either `error` or `response` is
192 # available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700193 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
194 # method returns no data on success, such as `Delete`, the response is
195 # `google.protobuf.Empty`. If the original method is standard
196 # `Get`/`Create`/`Update`, the response should be the resource. For other
197 # methods, the response should have the type `XxxResponse`, where `Xxx`
198 # is the original method name. For example, if the original method name
199 # is `TakeSnapshot()`, the inferred response type is
200 # `TakeSnapshotResponse`.
201 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
202 },
203 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
204 # originally returns it. If you use the default HTTP mapping, the
205 # `name` should be a resource name ending with `operations/{unique_id}`.
206 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
207 # different programming environments, including REST APIs and RPC APIs. It is
208 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
209 # three pieces of data: error code, error message, and error details.
210 #
211 # You can find out more about this error model and how to work with it in the
212 # [API Design Guide](https://cloud.google.com/apis/design/errors).
213 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
214 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
215 # user-facing error message should be localized and sent in the
216 # google.rpc.Status.details field, or localized by the client.
217 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
218 # message types for APIs to use.
219 {
220 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
221 },
222 ],
223 },
224 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
225 # contains progress information and common metadata such as create time.
226 # Some services might not provide such metadata. Any method that returns a
227 # long-running operation should document the metadata type, if any.
228 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
229 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700230 }</pre>
231</div>
232
233</body></html>