• 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_v2_8.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_8.cities.html">cities</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#list">list(profileId, dartIds=None, namePrefix=None, regionDartIds=None, countryDartIds=None)</a></code></p>
79<p class="firstline">Retrieves a list of cities, possibly filtered.</p>
80<h3>Method Details</h3>
81<div class="method">
82    <code class="details" id="list">list(profileId, dartIds=None, namePrefix=None, regionDartIds=None, countryDartIds=None)</code>
83  <pre>Retrieves a list of cities, possibly filtered.
84
85Args:
86  profileId: string, User profile ID associated with this request. (required)
87  dartIds: string, Select only cities with these DART IDs. (repeated)
88  namePrefix: string, Select only cities with names starting with this prefix.
89  regionDartIds: string, Select only cities from these regions. (repeated)
90  countryDartIds: string, Select only cities from these countries. (repeated)
91
92Returns:
93  An object of the form:
94
95    { # City List Response
96    "kind": "dfareporting#citiesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#citiesListResponse".
97    "cities": [ # City collection.
98      { # Contains information about a city that can be targeted by ads.
99        "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
100        "countryDartId": "A String", # DART ID of the country to which this city belongs.
101        "name": "A String", # Name of this city.
102        "countryCode": "A String", # Country code of the country to which this city belongs.
103        "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
104        "regionCode": "A String", # Region code of the region to which this city belongs.
105        "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
106        "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
107        "regionDartId": "A String", # DART ID of the region to which this city belongs.
108      },
109    ],
110  }</pre>
111</div>
112
113</body></html>