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