• 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.postalCodes.html">postalCodes</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#get">get(profileId, code)</a></code></p>
79<p class="firstline">Gets one postal code by ID.</p>
80<p class="toc_element">
81  <code><a href="#list">list(profileId)</a></code></p>
82<p class="firstline">Retrieves a list of postal codes.</p>
83<h3>Method Details</h3>
84<div class="method">
85    <code class="details" id="get">get(profileId, code)</code>
86  <pre>Gets one postal code by ID.
87
88Args:
89  profileId: string, User profile ID associated with this request. (required)
90  code: string, Postal code ID. (required)
91
92Returns:
93  An object of the form:
94
95    { # Contains information about a postal code that can be targeted by ads.
96    "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
97    "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
98    "code": "A String", # Postal code. This is equivalent to the id field.
99    "id": "A String", # ID of this postal code.
100    "countryCode": "A String", # Country code of the country to which this postal code belongs.
101  }</pre>
102</div>
103
104<div class="method">
105    <code class="details" id="list">list(profileId)</code>
106  <pre>Retrieves a list of postal codes.
107
108Args:
109  profileId: string, User profile ID associated with this request. (required)
110
111Returns:
112  An object of the form:
113
114    { # Postal Code List Response
115    "kind": "dfareporting#postalCodesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCodesListResponse".
116    "postalCodes": [ # Postal code collection.
117      { # Contains information about a postal code that can be targeted by ads.
118        "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
119        "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
120        "code": "A String", # Postal code. This is equivalent to the id field.
121        "id": "A String", # ID of this postal code.
122        "countryCode": "A String", # Country code of the country to which this postal code belongs.
123      },
124    ],
125  }</pre>
126</div>
127
128</body></html>