• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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="dfareporting_v3_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v3_1.videoFormats.html">videoFormats</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#get">get(profileId, id)</a></code></p>
79<p class="firstline">Gets one video format by ID.</p>
80<p class="toc_element">
81  <code><a href="#list">list(profileId)</a></code></p>
82<p class="firstline">Lists available video formats.</p>
83<h3>Method Details</h3>
84<div class="method">
85    <code class="details" id="get">get(profileId, id)</code>
86  <pre>Gets one video format by ID.
87
88Args:
89  profileId: string, User profile ID associated with this request. (required)
90  id: integer, Video format ID. (required)
91
92Returns:
93  An object of the form:
94
95    { # Contains information about supported video formats.
96    "fileType": "A String", # File type of the video format.
97    "resolution": { # Represents the dimensions of ads, placements, creatives, or creative assets. # The resolution of this video format.
98      "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
99      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
100      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
101      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
102      "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
103    },
104    "id": 42, # ID of the video format.
105    "kind": "dfareporting#videoFormat", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoFormat".
106    "targetBitRate": 42, # The target bit rate of this video format.
107  }</pre>
108</div>
109
110<div class="method">
111    <code class="details" id="list">list(profileId)</code>
112  <pre>Lists available video formats.
113
114Args:
115  profileId: string, User profile ID associated with this request. (required)
116
117Returns:
118  An object of the form:
119
120    { # Video Format List Response
121    "kind": "dfareporting#videoFormatsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoFormatsListResponse".
122    "videoFormats": [ # Video format collection.
123      { # Contains information about supported video formats.
124        "fileType": "A String", # File type of the video format.
125        "resolution": { # Represents the dimensions of ads, placements, creatives, or creative assets. # The resolution of this video format.
126          "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
127          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
128          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
129          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
130          "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
131        },
132        "id": 42, # ID of the video format.
133        "kind": "dfareporting#videoFormat", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoFormat".
134        "targetBitRate": 42, # The target bit rate of this video format.
135      },
136    ],
137  }</pre>
138</div>
139
140</body></html>