• 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.landingPages.html">landingPages</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#delete">delete(profileId, campaignId, id)</a></code></p>
79<p class="firstline">Deletes an existing campaign landing page.</p>
80<p class="toc_element">
81  <code><a href="#get">get(profileId, campaignId, id)</a></code></p>
82<p class="firstline">Gets one campaign landing page by ID.</p>
83<p class="toc_element">
84  <code><a href="#insert">insert(profileId, campaignId, body)</a></code></p>
85<p class="firstline">Inserts a new landing page for the specified campaign.</p>
86<p class="toc_element">
87  <code><a href="#list">list(profileId, campaignId)</a></code></p>
88<p class="firstline">Retrieves the list of landing pages for the specified campaign.</p>
89<p class="toc_element">
90  <code><a href="#patch">patch(profileId, campaignId, id, body)</a></code></p>
91<p class="firstline">Updates an existing campaign landing page. This method supports patch semantics.</p>
92<p class="toc_element">
93  <code><a href="#update">update(profileId, campaignId, body)</a></code></p>
94<p class="firstline">Updates an existing campaign landing page.</p>
95<h3>Method Details</h3>
96<div class="method">
97    <code class="details" id="delete">delete(profileId, campaignId, id)</code>
98  <pre>Deletes an existing campaign landing page.
99
100Args:
101  profileId: string, User profile ID associated with this request. (required)
102  campaignId: string, Landing page campaign ID. (required)
103  id: string, Landing page ID. (required)
104</pre>
105</div>
106
107<div class="method">
108    <code class="details" id="get">get(profileId, campaignId, id)</code>
109  <pre>Gets one campaign landing page by ID.
110
111Args:
112  profileId: string, User profile ID associated with this request. (required)
113  campaignId: string, Landing page campaign ID. (required)
114  id: string, Landing page ID. (required)
115
116Returns:
117  An object of the form:
118
119    { # Contains information about where a user's browser is taken after the user clicks an ad.
120      "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
121      "url": "A String", # URL of this landing page. This is a required field.
122      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
123      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
124      "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
125    }</pre>
126</div>
127
128<div class="method">
129    <code class="details" id="insert">insert(profileId, campaignId, body)</code>
130  <pre>Inserts a new landing page for the specified campaign.
131
132Args:
133  profileId: string, User profile ID associated with this request. (required)
134  campaignId: string, Landing page campaign ID. (required)
135  body: object, The request body. (required)
136    The object takes the form of:
137
138{ # Contains information about where a user's browser is taken after the user clicks an ad.
139    "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
140    "url": "A String", # URL of this landing page. This is a required field.
141    "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
142    "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
143    "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
144  }
145
146
147Returns:
148  An object of the form:
149
150    { # Contains information about where a user's browser is taken after the user clicks an ad.
151      "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
152      "url": "A String", # URL of this landing page. This is a required field.
153      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
154      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
155      "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
156    }</pre>
157</div>
158
159<div class="method">
160    <code class="details" id="list">list(profileId, campaignId)</code>
161  <pre>Retrieves the list of landing pages for the specified campaign.
162
163Args:
164  profileId: string, User profile ID associated with this request. (required)
165  campaignId: string, Landing page campaign ID. (required)
166
167Returns:
168  An object of the form:
169
170    { # Landing Page List Response
171    "kind": "dfareporting#landingPagesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPagesListResponse".
172    "landingPages": [ # Landing page collection
173      { # Contains information about where a user's browser is taken after the user clicks an ad.
174          "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
175          "url": "A String", # URL of this landing page. This is a required field.
176          "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
177          "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
178          "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
179        },
180    ],
181  }</pre>
182</div>
183
184<div class="method">
185    <code class="details" id="patch">patch(profileId, campaignId, id, body)</code>
186  <pre>Updates an existing campaign landing page. This method supports patch semantics.
187
188Args:
189  profileId: string, User profile ID associated with this request. (required)
190  campaignId: string, Landing page campaign ID. (required)
191  id: string, Landing page ID. (required)
192  body: object, The request body. (required)
193    The object takes the form of:
194
195{ # Contains information about where a user's browser is taken after the user clicks an ad.
196    "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
197    "url": "A String", # URL of this landing page. This is a required field.
198    "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
199    "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
200    "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
201  }
202
203
204Returns:
205  An object of the form:
206
207    { # Contains information about where a user's browser is taken after the user clicks an ad.
208      "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
209      "url": "A String", # URL of this landing page. This is a required field.
210      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
211      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
212      "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
213    }</pre>
214</div>
215
216<div class="method">
217    <code class="details" id="update">update(profileId, campaignId, body)</code>
218  <pre>Updates an existing campaign landing page.
219
220Args:
221  profileId: string, User profile ID associated with this request. (required)
222  campaignId: string, Landing page campaign ID. (required)
223  body: object, The request body. (required)
224    The object takes the form of:
225
226{ # Contains information about where a user's browser is taken after the user clicks an ad.
227    "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
228    "url": "A String", # URL of this landing page. This is a required field.
229    "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
230    "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
231    "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
232  }
233
234
235Returns:
236  An object of the form:
237
238    { # Contains information about where a user's browser is taken after the user clicks an ad.
239      "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
240      "url": "A String", # URL of this landing page. This is a required field.
241      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
242      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
243      "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
244    }</pre>
245</div>
246
247</body></html>