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_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v3_1.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, archived=None, searchString=None, subaccountId=None, pageToken=None, sortField=None, advertiserIds=None, maxResults=None, ids=None, sortOrder=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, archived=None, searchString=None, subaccountId=None, pageToken=None, sortField=None, advertiserIds=None, maxResults=None, ids=None, sortOrder=None)</code>
202  <pre>Retrieves a list of landing pages.
203
204Args:
205  profileId: string, User profile ID associated with this request. (required)
206  archived: boolean, Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages.
207  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".
208  subaccountId: string, Select only landing pages that belong to this subaccount.
209  pageToken: string, Value of the nextPageToken from the previous result page.
210  sortField: string, Field by which to sort the list.
211    Allowed values
212      ID -
213      NAME -
214  advertiserIds: string, Select only landing pages that belong to these advertisers. (repeated)
215  maxResults: integer, Maximum number of results to return.
216  ids: string, Select only landing pages with these IDs. (repeated)
217  sortOrder: string, Order of sorted results.
218    Allowed values
219      ASCENDING -
220      DESCENDING -
221
222Returns:
223  An object of the form:
224
225    { # Landing Page List Response
226    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
227    "kind": "dfareporting#advertiserLandingPagesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserLandingPagesListResponse".
228    "landingPages": [ # Landing page collection
229      { # Contains information about where a user's browser is taken after the user clicks an ad.
230          "archived": True or False, # Whether this landing page has been archived.
231          "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long.
232          "url": "A String", # URL of this landing page. This is a required field.
233          "deepLinks": [ # Links that will direct the user to a mobile app, if installed.
234            { # Contains information about a landing page deep link.
235              "mobileApp": { # Contains information about a mobile app. Used as a landing page deep link. # The mobile app targeted by this deep link.
236                "directory": "A String", # Mobile app directory.
237                "kind": "dfareporting#mobileApp", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp".
238                "publisherName": "A String", # Publisher name.
239                "id": "A String", # ID of this mobile app.
240                "title": "A String", # Title of this mobile app.
241              },
242              "appUrl": "A String", # The URL of the mobile app being linked to.
243              "kind": "dfareporting#deepLink", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink".
244              "fallbackUrl": "A String", # The fallback URL. This URL will be served to users who do not have the mobile app installed.
245              "remarketingListIds": [ # Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.
246                "A String",
247              ],
248            },
249          ],
250          "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
251          "advertiserId": "A String", # Advertiser ID of this landing page. This is a required field.
252          "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
253        },
254    ],
255  }</pre>
256</div>
257
258<div class="method">
259    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
260  <pre>Retrieves the next page of results.
261
262Args:
263  previous_request: The request for the previous page. (required)
264  previous_response: The response from the request for the previous page. (required)
265
266Returns:
267  A request object that you can call 'execute()' on to request the next
268  page. Returns None if there are no more items in the collection.
269    </pre>
270</div>
271
272<div class="method">
273    <code class="details" id="patch">patch(profileId, id, body)</code>
274  <pre>Updates an existing landing page. This method supports patch semantics.
275
276Args:
277  profileId: string, User profile ID associated with this request. (required)
278  id: string, Landing page ID. (required)
279  body: object, The request body. (required)
280    The object takes the form of:
281
282{ # Contains information about where a user's browser is taken after the user clicks an ad.
283    "archived": True or False, # Whether this landing page has been archived.
284    "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long.
285    "url": "A String", # URL of this landing page. This is a required field.
286    "deepLinks": [ # Links that will direct the user to a mobile app, if installed.
287      { # Contains information about a landing page deep link.
288        "mobileApp": { # Contains information about a mobile app. Used as a landing page deep link. # The mobile app targeted by this deep link.
289          "directory": "A String", # Mobile app directory.
290          "kind": "dfareporting#mobileApp", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp".
291          "publisherName": "A String", # Publisher name.
292          "id": "A String", # ID of this mobile app.
293          "title": "A String", # Title of this mobile app.
294        },
295        "appUrl": "A String", # The URL of the mobile app being linked to.
296        "kind": "dfareporting#deepLink", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink".
297        "fallbackUrl": "A String", # The fallback URL. This URL will be served to users who do not have the mobile app installed.
298        "remarketingListIds": [ # Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.
299          "A String",
300        ],
301      },
302    ],
303    "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
304    "advertiserId": "A String", # Advertiser ID of this landing page. This is a required field.
305    "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
306  }
307
308
309Returns:
310  An object of the form:
311
312    { # Contains information about where a user's browser is taken after the user clicks an ad.
313      "archived": True or False, # Whether this landing page has been archived.
314      "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long.
315      "url": "A String", # URL of this landing page. This is a required field.
316      "deepLinks": [ # Links that will direct the user to a mobile app, if installed.
317        { # Contains information about a landing page deep link.
318          "mobileApp": { # Contains information about a mobile app. Used as a landing page deep link. # The mobile app targeted by this deep link.
319            "directory": "A String", # Mobile app directory.
320            "kind": "dfareporting#mobileApp", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp".
321            "publisherName": "A String", # Publisher name.
322            "id": "A String", # ID of this mobile app.
323            "title": "A String", # Title of this mobile app.
324          },
325          "appUrl": "A String", # The URL of the mobile app being linked to.
326          "kind": "dfareporting#deepLink", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink".
327          "fallbackUrl": "A String", # The fallback URL. This URL will be served to users who do not have the mobile app installed.
328          "remarketingListIds": [ # Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.
329            "A String",
330          ],
331        },
332      ],
333      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
334      "advertiserId": "A String", # Advertiser ID of this landing page. This is a required field.
335      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
336    }</pre>
337</div>
338
339<div class="method">
340    <code class="details" id="update">update(profileId, body)</code>
341  <pre>Updates an existing landing page.
342
343Args:
344  profileId: string, User profile ID associated with this request. (required)
345  body: object, The request body. (required)
346    The object takes the form of:
347
348{ # Contains information about where a user's browser is taken after the user clicks an ad.
349    "archived": True or False, # Whether this landing page has been archived.
350    "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long.
351    "url": "A String", # URL of this landing page. This is a required field.
352    "deepLinks": [ # Links that will direct the user to a mobile app, if installed.
353      { # Contains information about a landing page deep link.
354        "mobileApp": { # Contains information about a mobile app. Used as a landing page deep link. # The mobile app targeted by this deep link.
355          "directory": "A String", # Mobile app directory.
356          "kind": "dfareporting#mobileApp", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp".
357          "publisherName": "A String", # Publisher name.
358          "id": "A String", # ID of this mobile app.
359          "title": "A String", # Title of this mobile app.
360        },
361        "appUrl": "A String", # The URL of the mobile app being linked to.
362        "kind": "dfareporting#deepLink", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink".
363        "fallbackUrl": "A String", # The fallback URL. This URL will be served to users who do not have the mobile app installed.
364        "remarketingListIds": [ # Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.
365          "A String",
366        ],
367      },
368    ],
369    "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
370    "advertiserId": "A String", # Advertiser ID of this landing page. This is a required field.
371    "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
372  }
373
374
375Returns:
376  An object of the form:
377
378    { # Contains information about where a user's browser is taken after the user clicks an ad.
379      "archived": True or False, # Whether this landing page has been archived.
380      "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long.
381      "url": "A String", # URL of this landing page. This is a required field.
382      "deepLinks": [ # Links that will direct the user to a mobile app, if installed.
383        { # Contains information about a landing page deep link.
384          "mobileApp": { # Contains information about a mobile app. Used as a landing page deep link. # The mobile app targeted by this deep link.
385            "directory": "A String", # Mobile app directory.
386            "kind": "dfareporting#mobileApp", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp".
387            "publisherName": "A String", # Publisher name.
388            "id": "A String", # ID of this mobile app.
389            "title": "A String", # Title of this mobile app.
390          },
391          "appUrl": "A String", # The URL of the mobile app being linked to.
392          "kind": "dfareporting#deepLink", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink".
393          "fallbackUrl": "A String", # The fallback URL. This URL will be served to users who do not have the mobile app installed.
394          "remarketingListIds": [ # Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.
395            "A String",
396          ],
397        },
398      ],
399      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
400      "advertiserId": "A String", # Advertiser ID of this landing page. This is a required field.
401      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
402    }</pre>
403</div>
404
405</body></html>