• 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_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v3_2.sizes.html">sizes</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 size by ID.</p>
80<p class="toc_element">
81  <code><a href="#insert">insert(profileId, body)</a></code></p>
82<p class="firstline">Inserts a new size.</p>
83<p class="toc_element">
84  <code><a href="#list">list(profileId, iabStandard=None, width=None, ids=None, height=None)</a></code></p>
85<p class="firstline">Retrieves a list of sizes, possibly filtered. Retrieved sizes are globally unique and may include values not currently in use by your account. Due to this, the list of sizes returned by this method may differ from the list seen in the Trafficking UI.</p>
86<h3>Method Details</h3>
87<div class="method">
88    <code class="details" id="get">get(profileId, id)</code>
89  <pre>Gets one size by ID.
90
91Args:
92  profileId: string, User profile ID associated with this request. (required)
93  id: string, Size ID. (required)
94
95Returns:
96  An object of the form:
97
98    { # Represents the dimensions of ads, placements, creatives, or creative assets.
99    "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
100    "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
101    "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
102    "id": "A String", # ID of this size. This is a read-only, auto-generated field.
103    "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
104  }</pre>
105</div>
106
107<div class="method">
108    <code class="details" id="insert">insert(profileId, body)</code>
109  <pre>Inserts a new size.
110
111Args:
112  profileId: string, User profile ID associated with this request. (required)
113  body: object, The request body. (required)
114    The object takes the form of:
115
116{ # Represents the dimensions of ads, placements, creatives, or creative assets.
117  "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
118  "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
119  "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
120  "id": "A String", # ID of this size. This is a read-only, auto-generated field.
121  "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
122}
123
124
125Returns:
126  An object of the form:
127
128    { # Represents the dimensions of ads, placements, creatives, or creative assets.
129    "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
130    "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
131    "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
132    "id": "A String", # ID of this size. This is a read-only, auto-generated field.
133    "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
134  }</pre>
135</div>
136
137<div class="method">
138    <code class="details" id="list">list(profileId, iabStandard=None, width=None, ids=None, height=None)</code>
139  <pre>Retrieves a list of sizes, possibly filtered. Retrieved sizes are globally unique and may include values not currently in use by your account. Due to this, the list of sizes returned by this method may differ from the list seen in the Trafficking UI.
140
141Args:
142  profileId: string, User profile ID associated with this request. (required)
143  iabStandard: boolean, Select only IAB standard sizes.
144  width: integer, Select only sizes with this width.
145  ids: string, Select only sizes with these IDs. (repeated)
146  height: integer, Select only sizes with this height.
147
148Returns:
149  An object of the form:
150
151    { # Size List Response
152    "kind": "dfareporting#sizesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#sizesListResponse".
153    "sizes": [ # Size collection.
154      { # Represents the dimensions of ads, placements, creatives, or creative assets.
155        "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
156        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
157        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
158        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
159        "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
160      },
161    ],
162  }</pre>
163</div>
164
165</body></html>