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_3.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v3_3.advertiserLandingPages.html">advertiserLandingPages</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 landing page 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 landing page.</p>
83<p class="toc_element">
84  <code><a href="#list">list(profileId, campaignIds=None, archived=None, pageToken=None, advertiserIds=None, sortOrder=None, maxResults=None, searchString=None, subaccountId=None, sortField=None, ids=None)</a></code></p>
85<p class="firstline">Retrieves a list of landing pages.</p>
86<p class="toc_element">
87  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<p class="toc_element">
90  <code><a href="#patch">patch(profileId, id, body)</a></code></p>
91<p class="firstline">Updates an existing landing page. This method supports patch semantics.</p>
92<p class="toc_element">
93  <code><a href="#update">update(profileId, body)</a></code></p>
94<p class="firstline">Updates an existing landing page.</p>
95<h3>Method Details</h3>
96<div class="method">
97    <code class="details" id="get">get(profileId, id)</code>
98  <pre>Gets one landing page by ID.
99
100Args:
101  profileId: string, User profile ID associated with this request. (required)
102  id: string, Landing page ID. (required)
103
104Returns:
105  An object of the form:
106
107    { # Contains information about where a user's browser is taken after the user clicks an ad.
108      "archived": True or False, # Whether this landing page has been archived.
109      "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long.
110      "url": "A String", # URL of this landing page. This is a required field.
111      "deepLinks": [ # Links that will direct the user to a mobile app, if installed.
112        { # Contains information about a landing page deep link.
113          "mobileApp": { # Contains information about a mobile app. Used as a landing page deep link. # The mobile app targeted by this deep link.
114            "directory": "A String", # Mobile app directory.
115            "kind": "dfareporting#mobileApp", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp".
116            "publisherName": "A String", # Publisher name.
117            "id": "A String", # ID of this mobile app.
118            "title": "A String", # Title of this mobile app.
119          },
120          "appUrl": "A String", # The URL of the mobile app being linked to.
121          "kind": "dfareporting#deepLink", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink".
122          "fallbackUrl": "A String", # The fallback URL. This URL will be served to users who do not have the mobile app installed.
123          "remarketingListIds": [ # Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.
124            "A String",
125          ],
126        },
127      ],
128      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
129      "advertiserId": "A String", # Advertiser ID of this landing page. This is a required field.
130      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
131    }</pre>
132</div>
133
134<div class="method">
135    <code class="details" id="insert">insert(profileId, body)</code>
136  <pre>Inserts a new landing page.
137
138Args:
139  profileId: string, User profile ID associated with this request. (required)
140  body: object, The request body. (required)
141    The object takes the form of:
142
143{ # Contains information about where a user's browser is taken after the user clicks an ad.
144    "archived": True or False, # Whether this landing page has been archived.
145    "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long.
146    "url": "A String", # URL of this landing page. This is a required field.
147    "deepLinks": [ # Links that will direct the user to a mobile app, if installed.
148      { # Contains information about a landing page deep link.
149        "mobileApp": { # Contains information about a mobile app. Used as a landing page deep link. # The mobile app targeted by this deep link.
150          "directory": "A String", # Mobile app directory.
151          "kind": "dfareporting#mobileApp", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp".
152          "publisherName": "A String", # Publisher name.
153          "id": "A String", # ID of this mobile app.
154          "title": "A String", # Title of this mobile app.
155        },
156        "appUrl": "A String", # The URL of the mobile app being linked to.
157        "kind": "dfareporting#deepLink", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink".
158        "fallbackUrl": "A String", # The fallback URL. This URL will be served to users who do not have the mobile app installed.
159        "remarketingListIds": [ # Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.
160          "A String",
161        ],
162      },
163    ],
164    "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
165    "advertiserId": "A String", # Advertiser ID of this landing page. This is a required field.
166    "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
167  }
168
169
170Returns:
171  An object of the form:
172
173    { # Contains information about where a user's browser is taken after the user clicks an ad.
174      "archived": True or False, # Whether this landing page has been archived.
175      "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long.
176      "url": "A String", # URL of this landing page. This is a required field.
177      "deepLinks": [ # Links that will direct the user to a mobile app, if installed.
178        { # Contains information about a landing page deep link.
179          "mobileApp": { # Contains information about a mobile app. Used as a landing page deep link. # The mobile app targeted by this deep link.
180            "directory": "A String", # Mobile app directory.
181            "kind": "dfareporting#mobileApp", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp".
182            "publisherName": "A String", # Publisher name.
183            "id": "A String", # ID of this mobile app.
184            "title": "A String", # Title of this mobile app.
185          },
186          "appUrl": "A String", # The URL of the mobile app being linked to.
187          "kind": "dfareporting#deepLink", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink".
188          "fallbackUrl": "A String", # The fallback URL. This URL will be served to users who do not have the mobile app installed.
189          "remarketingListIds": [ # Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.
190            "A String",
191          ],
192        },
193      ],
194      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
195      "advertiserId": "A String", # Advertiser ID of this landing page. This is a required field.
196      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
197    }</pre>
198</div>
199
200<div class="method">
201    <code class="details" id="list">list(profileId, campaignIds=None, archived=None, pageToken=None, advertiserIds=None, sortOrder=None, maxResults=None, searchString=None, subaccountId=None, sortField=None, ids=None)</code>
202  <pre>Retrieves a list of landing pages.
203
204Args:
205  profileId: string, User profile ID associated with this request. (required)
206  campaignIds: string, Select only landing pages that are associated with these campaigns. (repeated)
207  archived: boolean, Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages.
208  pageToken: string, Value of the nextPageToken from the previous result page.
209  advertiserIds: string, Select only landing pages that belong to these advertisers. (repeated)
210  sortOrder: string, Order of sorted results.
211    Allowed values
212      ASCENDING -
213      DESCENDING -
214  maxResults: integer, Maximum number of results to return.
215  searchString: string, Allows searching for landing pages by name or ID. Wildcards (*) are allowed. For example, "landingpage*2017" will return landing pages with names like "landingpage July 2017", "landingpage March 2017", or simply "landingpage 2017". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "landingpage" will match campaigns with name "my landingpage", "landingpage 2015", or simply "landingpage".
216  subaccountId: string, Select only landing pages that belong to this subaccount.
217  sortField: string, Field by which to sort the list.
218    Allowed values
219      ID -
220      NAME -
221  ids: string, Select only landing pages with these IDs. (repeated)
222
223Returns:
224  An object of the form:
225
226    { # Landing Page List Response
227    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
228    "kind": "dfareporting#advertiserLandingPagesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserLandingPagesListResponse".
229    "landingPages": [ # Landing page collection
230      { # Contains information about where a user's browser is taken after the user clicks an ad.
231          "archived": True or False, # Whether this landing page has been archived.
232          "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long.
233          "url": "A String", # URL of this landing page. This is a required field.
234          "deepLinks": [ # Links that will direct the user to a mobile app, if installed.
235            { # Contains information about a landing page deep link.
236              "mobileApp": { # Contains information about a mobile app. Used as a landing page deep link. # The mobile app targeted by this deep link.
237                "directory": "A String", # Mobile app directory.
238                "kind": "dfareporting#mobileApp", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp".
239                "publisherName": "A String", # Publisher name.
240                "id": "A String", # ID of this mobile app.
241                "title": "A String", # Title of this mobile app.
242              },
243              "appUrl": "A String", # The URL of the mobile app being linked to.
244              "kind": "dfareporting#deepLink", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink".
245              "fallbackUrl": "A String", # The fallback URL. This URL will be served to users who do not have the mobile app installed.
246              "remarketingListIds": [ # Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.
247                "A String",
248              ],
249            },
250          ],
251          "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
252          "advertiserId": "A String", # Advertiser ID of this landing page. This is a required field.
253          "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
254        },
255    ],
256  }</pre>
257</div>
258
259<div class="method">
260    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
261  <pre>Retrieves the next page of results.
262
263Args:
264  previous_request: The request for the previous page. (required)
265  previous_response: The response from the request for the previous page. (required)
266
267Returns:
268  A request object that you can call 'execute()' on to request the next
269  page. Returns None if there are no more items in the collection.
270    </pre>
271</div>
272
273<div class="method">
274    <code class="details" id="patch">patch(profileId, id, body)</code>
275  <pre>Updates an existing landing page. This method supports patch semantics.
276
277Args:
278  profileId: string, User profile ID associated with this request. (required)
279  id: string, Landing page ID. (required)
280  body: object, The request body. (required)
281    The object takes the form of:
282
283{ # Contains information about where a user's browser is taken after the user clicks an ad.
284    "archived": True or False, # Whether this landing page has been archived.
285    "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long.
286    "url": "A String", # URL of this landing page. This is a required field.
287    "deepLinks": [ # Links that will direct the user to a mobile app, if installed.
288      { # Contains information about a landing page deep link.
289        "mobileApp": { # Contains information about a mobile app. Used as a landing page deep link. # The mobile app targeted by this deep link.
290          "directory": "A String", # Mobile app directory.
291          "kind": "dfareporting#mobileApp", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp".
292          "publisherName": "A String", # Publisher name.
293          "id": "A String", # ID of this mobile app.
294          "title": "A String", # Title of this mobile app.
295        },
296        "appUrl": "A String", # The URL of the mobile app being linked to.
297        "kind": "dfareporting#deepLink", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink".
298        "fallbackUrl": "A String", # The fallback URL. This URL will be served to users who do not have the mobile app installed.
299        "remarketingListIds": [ # Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.
300          "A String",
301        ],
302      },
303    ],
304    "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
305    "advertiserId": "A String", # Advertiser ID of this landing page. This is a required field.
306    "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
307  }
308
309
310Returns:
311  An object of the form:
312
313    { # Contains information about where a user's browser is taken after the user clicks an ad.
314      "archived": True or False, # Whether this landing page has been archived.
315      "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long.
316      "url": "A String", # URL of this landing page. This is a required field.
317      "deepLinks": [ # Links that will direct the user to a mobile app, if installed.
318        { # Contains information about a landing page deep link.
319          "mobileApp": { # Contains information about a mobile app. Used as a landing page deep link. # The mobile app targeted by this deep link.
320            "directory": "A String", # Mobile app directory.
321            "kind": "dfareporting#mobileApp", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp".
322            "publisherName": "A String", # Publisher name.
323            "id": "A String", # ID of this mobile app.
324            "title": "A String", # Title of this mobile app.
325          },
326          "appUrl": "A String", # The URL of the mobile app being linked to.
327          "kind": "dfareporting#deepLink", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink".
328          "fallbackUrl": "A String", # The fallback URL. This URL will be served to users who do not have the mobile app installed.
329          "remarketingListIds": [ # Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.
330            "A String",
331          ],
332        },
333      ],
334      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
335      "advertiserId": "A String", # Advertiser ID of this landing page. This is a required field.
336      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
337    }</pre>
338</div>
339
340<div class="method">
341    <code class="details" id="update">update(profileId, body)</code>
342  <pre>Updates an existing landing page.
343
344Args:
345  profileId: string, User profile ID associated with this request. (required)
346  body: object, The request body. (required)
347    The object takes the form of:
348
349{ # Contains information about where a user's browser is taken after the user clicks an ad.
350    "archived": True or False, # Whether this landing page has been archived.
351    "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long.
352    "url": "A String", # URL of this landing page. This is a required field.
353    "deepLinks": [ # Links that will direct the user to a mobile app, if installed.
354      { # Contains information about a landing page deep link.
355        "mobileApp": { # Contains information about a mobile app. Used as a landing page deep link. # The mobile app targeted by this deep link.
356          "directory": "A String", # Mobile app directory.
357          "kind": "dfareporting#mobileApp", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp".
358          "publisherName": "A String", # Publisher name.
359          "id": "A String", # ID of this mobile app.
360          "title": "A String", # Title of this mobile app.
361        },
362        "appUrl": "A String", # The URL of the mobile app being linked to.
363        "kind": "dfareporting#deepLink", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink".
364        "fallbackUrl": "A String", # The fallback URL. This URL will be served to users who do not have the mobile app installed.
365        "remarketingListIds": [ # Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.
366          "A String",
367        ],
368      },
369    ],
370    "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
371    "advertiserId": "A String", # Advertiser ID of this landing page. This is a required field.
372    "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
373  }
374
375
376Returns:
377  An object of the form:
378
379    { # Contains information about where a user's browser is taken after the user clicks an ad.
380      "archived": True or False, # Whether this landing page has been archived.
381      "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long.
382      "url": "A String", # URL of this landing page. This is a required field.
383      "deepLinks": [ # Links that will direct the user to a mobile app, if installed.
384        { # Contains information about a landing page deep link.
385          "mobileApp": { # Contains information about a mobile app. Used as a landing page deep link. # The mobile app targeted by this deep link.
386            "directory": "A String", # Mobile app directory.
387            "kind": "dfareporting#mobileApp", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp".
388            "publisherName": "A String", # Publisher name.
389            "id": "A String", # ID of this mobile app.
390            "title": "A String", # Title of this mobile app.
391          },
392          "appUrl": "A String", # The URL of the mobile app being linked to.
393          "kind": "dfareporting#deepLink", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink".
394          "fallbackUrl": "A String", # The fallback URL. This URL will be served to users who do not have the mobile app installed.
395          "remarketingListIds": [ # Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.
396            "A String",
397          ],
398        },
399      ],
400      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
401      "advertiserId": "A String", # Advertiser ID of this landing page. This is a required field.
402      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
403    }</pre>
404</div>
405
406</body></html>