1<!DOCTYPE html> 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99<html> 100<head> 101 102 103<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 104<meta name="viewport" content="width=device-width" /> 105 106<link rel="shortcut icon" type="image/x-icon" href="/favicon.ico" /> 107<title>Promotion | Android Developers</title> 108 109<!-- STYLESHEETS --> 110<link rel="stylesheet" 111href="//fonts.googleapis.com/css?family=Roboto+Condensed"> 112<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Roboto:light,regular,medium,thin,italic,mediumitalic,bold" 113 title="roboto"> 114<link href="/assets/css/default.css?v=4" rel="stylesheet" type="text/css"> 115 116 117 118<!-- JAVASCRIPT --> 119<script src="//www.google.com/jsapi" type="text/javascript"></script> 120<script src="/assets/js/android_3p-bundle.js" type="text/javascript"></script> 121<script type="text/javascript"> 122 var toRoot = "/"; 123 var metaTags = []; 124 var devsite = false; 125</script> 126<script src="/assets/js/docs.js?v=3" type="text/javascript"></script> 127 128 129 130<script> 131 (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ 132 (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), 133 m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) 134 })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); 135 136 ga('create', 'UA-5831155-1', 'android.com'); 137 ga('create', 'UA-49880327-2', 'android.com', {'name': 'universal'}); // New tracker); 138 ga('send', 'pageview'); 139 ga('universal.send', 'pageview'); // Send page view for new tracker. 140</script> 141 142</head> 143 144<body class="gc-documentation google 145 develop reference" itemscope itemtype="http://schema.org/Article"> 146 <div id="doc-api-level" class="" style="display:none"></div> 147 <a name="top"></a> 148 149 150<a name="top"></a> 151 152<!-- dialog to prompt lang pref change when loaded from hardcoded URL 153<div id="langMessage" style="display:none"> 154 <div> 155 <div class="lang en"> 156 <p>You requested a page in English, would you like to proceed with this language setting?</p> 157 </div> 158 <div class="lang es"> 159 <p>You requested a page in Spanish (Español), would you like to proceed with this language setting?</p> 160 </div> 161 <div class="lang ja"> 162 <p>You requested a page in Japanese (日本語), would you like to proceed with this language setting?</p> 163 </div> 164 <div class="lang ko"> 165 <p>You requested a page in Korean (한국어), would you like to proceed with this language setting?</p> 166 </div> 167 <div class="lang ru"> 168 <p>You requested a page in Russian (Русский), would you like to proceed with this language setting?</p> 169 </div> 170 <div class="lang zh-cn"> 171 <p>You requested a page in Simplified Chinese (简体中文), would you like to proceed with this language setting?</p> 172 </div> 173 <div class="lang zh-tw"> 174 <p>You requested a page in Traditional Chinese (繁體中文), would you like to proceed with this language setting?</p> 175 </div> 176 <a href="#" class="button yes" onclick="return false;"> 177 <span class="lang en">Yes</span> 178 <span class="lang es">Sí</span> 179 <span class="lang ja">Yes</span> 180 <span class="lang ko">Yes</span> 181 <span class="lang ru">Yes</span> 182 <span class="lang zh-cn">是的</span> 183 <span class="lang zh-tw">没有</span> 184 </a> 185 <a href="#" class="button" onclick="$('#langMessage').hide();return false;"> 186 <span class="lang en">No</span> 187 <span class="lang es">No</span> 188 <span class="lang ja">No</span> 189 <span class="lang ko">No</span> 190 <span class="lang ru">No</span> 191 <span class="lang zh-cn">没有</span> 192 <span class="lang zh-tw">没有</span> 193 </a> 194 </div> 195</div> --> 196 197 198 <!-- Header --> 199 <div id="header-wrapper"> 200 <div id="header"> 201 202 203 204 205 <div class="wrap" id="header-wrap"> 206 <div class="col-3 logo"> 207 <a href="/index.html"> 208 <img src="/assets/images/dac_logo.png" 209 srcset="/assets/images/dac_logo@2x.png 2x" 210 width="123" height="25" alt="Android Developers" /> 211 </a> 212 <div class="btn-quicknav" id="btn-quicknav"> 213 <a href="#" class="arrow-inactive">Quicknav</a> 214 <a href="#" class="arrow-active">Quicknav</a> 215 </div> 216 </div> 217 <ul class="nav-x col-9"> 218 <li class="design"> 219 <a href="/design/index.html" 220 zh-tw-lang="設計" 221 zh-cn-lang="设计" 222 ru-lang="Проектирование" 223 ko-lang="디자인" 224 ja-lang="設計" 225 es-lang="Diseñar" 226 >Design</a></li> 227 <li class="develop"><a href="/develop/index.html" 228 zh-tw-lang="開發" 229 zh-cn-lang="开发" 230 ru-lang="Разработка" 231 ko-lang="개발" 232 ja-lang="開発" 233 es-lang="Desarrollar" 234 >Develop</a></li> 235 <li class="distribute last"><a href="/distribute/index.html" 236 zh-tw-lang="發佈" 237 zh-cn-lang="分发" 238 ru-lang="Распространение" 239 ko-lang="배포" 240 ja-lang="配布" 241 es-lang="Distribuir" 242 >Distribute</a></li> 243 </ul> 244 245 246 247 248<div class="menu-container"> 249 <div class="moremenu"> 250 <div id="more-btn"></div> 251 </div> 252 <div class="morehover" id="moremenu"> 253 <div class="top"></div> 254 <div class="mid"> 255 <div class="header">Links</div> 256 <ul> 257 <li><a href="https://play.google.com/apps/publish/" target="_googleplay">Google Play Developer Console</a></li> 258 <li><a href="http://android-developers.blogspot.com/">Android Developers Blog</a></li> 259 <li><a href="/about/index.html">About Android</a></li> 260 </ul> 261 <div class="header">Android Sites</div> 262 <ul> 263 <li><a href="http://www.android.com">Android.com</a></li> 264 <li class="active"><a>Android Developers</a></li> 265 <li><a href="http://source.android.com">Android Open Source Project</a></li> 266 </ul> 267 268 269 270 <div class="header">Language</div> 271 <div id="language" class="locales"> 272 <select name="language" onChange="changeLangPref(this.value, true)"> 273 <option value="en">English</option> 274 <option value="es">Español</option> 275 <option value="ja">日本語</option> 276 <option value="ko">한국어</option> 277 <option value="ru">Русский</option> 278 <option value="zh-cn">中文（简体)</option> 279 <option value="zh-tw">中文（繁體)</option> 280 </select> 281 </div> 282 <script type="text/javascript"> 283 <!-- 284 loadLangPref(); 285 //--> 286 </script> 287 288 289 <br class="clearfix" /> 290 </div><!-- end 'mid' --> 291 <div class="bottom"></div> 292 </div><!-- end 'moremenu' --> 293 294 <div class="search" id="search-container"> 295 <div class="search-inner"> 296 <div id="search-btn"></div> 297 <div class="left"></div> 298 <form onsubmit="return submit_search()"> 299 <input id="search_autocomplete" type="text" value="" autocomplete="off" name="q" 300 onfocus="search_focus_changed(this, true)" onblur="search_focus_changed(this, false)" 301 onkeydown="return search_changed(event, true, '/')" 302 onkeyup="return search_changed(event, false, '/')" /> 303 </form> 304 <div class="right"></div> 305 <a class="close hide">close</a> 306 <div class="left"></div> 307 <div class="right"></div> 308 </div><!-- end search-inner --> 309 </div><!-- end search-container --> 310 311 <div class="search_filtered_wrapper reference"> 312 <div class="suggest-card reference no-display"> 313 <ul class="search_filtered"> 314 </ul> 315 </div> 316 </div> 317 318 <div class="search_filtered_wrapper docs"> 319 <div class="suggest-card dummy no-display"> </div> 320 <div class="suggest-card develop no-display"> 321 <ul class="search_filtered"> 322 </ul> 323 <div class="child-card guides no-display"> 324 </div> 325 <div class="child-card training no-display"> 326 </div> 327 <div class="child-card samples no-display"> 328 </div> 329 </div> 330 <div class="suggest-card design no-display"> 331 <ul class="search_filtered"> 332 </ul> 333 </div> 334 <div class="suggest-card distribute no-display"> 335 <ul class="search_filtered"> 336 </ul> 337 </div> 338 </div> 339</div><!-- end menu-container (search and menu widget) --> 340 341 342 343 <!-- Expanded quicknav --> 344 <div id="quicknav" class="col-13"> 345 <ul> 346 <li class="about"> 347 <ul> 348 <li><a href="/about/index.html">About</a></li> 349 <li><a href="/wear/index.html">Wear</a></li> 350 <li><a href="/tv/index.html">TV</a></li> 351 <li><a href="/auto/index.html">Auto</a></li> 352 </ul> 353 </li> 354 <li class="design"> 355 <ul> 356 <li><a href="/design/index.html">Get Started</a></li> 357 <li><a href="/design/devices.html">Devices</a></li> 358 <li><a href="/design/style/index.html">Style</a></li> 359 <li><a href="/design/patterns/index.html">Patterns</a></li> 360 <li><a href="/design/building-blocks/index.html">Building Blocks</a></li> 361 <li><a href="/design/downloads/index.html">Downloads</a></li> 362 <li><a href="/design/videos/index.html">Videos</a></li> 363 </ul> 364 </li> 365 <li class="develop"> 366 <ul> 367 <li><a href="/training/index.html" 368 zh-tw-lang="訓練課程" 369 zh-cn-lang="培训" 370 ru-lang="Курсы" 371 ko-lang="교육" 372 ja-lang="トレーニング" 373 es-lang="Capacitación" 374 >Training</a></li> 375 <li><a href="/guide/index.html" 376 zh-tw-lang="API 指南" 377 zh-cn-lang="API 指南" 378 ru-lang="Руководства по API" 379 ko-lang="API 가이드" 380 ja-lang="API ガイド" 381 es-lang="Guías de la API" 382 >API Guides</a></li> 383 <li><a href="/reference/packages.html" 384 zh-tw-lang="參考資源" 385 zh-cn-lang="参考" 386 ru-lang="Справочник" 387 ko-lang="참조문서" 388 ja-lang="リファレンス" 389 es-lang="Referencia" 390 >Reference</a></li> 391 <li><a href="/sdk/index.html" 392 zh-tw-lang="相關工具" 393 zh-cn-lang="工具" 394 ru-lang="Инструменты" 395 ko-lang="도구" 396 ja-lang="ツール" 397 es-lang="Herramientas" 398 >Tools</a> 399 </li> 400 <li><a href="/google/index.html">Google Services</a> 401 </li> 402 403 <li><a href="/samples/index.html">Samples</a> 404 </li> 405 406 </ul> 407 </li> 408 <li class="distribute last"> 409 <ul> 410 <li><a href="/distribute/googleplay/index.html">Google Play</a></li> 411 <li><a href="/distribute/essentials/index.html">Essentials</a></li> 412 <li><a href="/distribute/users/index.html">Get Users</a></li> 413 <li><a href="/distribute/engage/index.html">Engage & Retain</a></li> 414 <li><a href="/distribute/monetize/index.html">Monetize</a></li> 415 <li><a href="/distribute/tools/index.html">Tools & Reference</a></li> 416 <li><a href="/distribute/stories/index.html">Developer Stories</a></li> 417 </ul> 418 </li> 419 </ul> 420 </div><!-- /Expanded quicknav --> 421 </div><!-- end header-wrap.wrap --> 422 </div><!-- end header --> 423 424 425 <!-- Secondary x-nav --> 426 <div id="nav-x"> 427 <div class="wrap" style="position:relative;z-index:1"> 428 429 430 431 432 433 <ul class="nav-x col-9 develop" style="width:100%"> 434 <li class="training"><a href="/training/index.html" 435 zh-tw-lang="訓練課程" 436 zh-cn-lang="培训" 437 ru-lang="Курсы" 438 ko-lang="교육" 439 ja-lang="トレーニング" 440 es-lang="Capacitación" 441 >Training</a></li> 442 <li class="guide"><a href="/guide/index.html" 443 zh-tw-lang="API 指南" 444 zh-cn-lang="API 指南" 445 ru-lang="Руководства по API" 446 ko-lang="API 가이드" 447 ja-lang="API ガイド" 448 es-lang="Guías de la API" 449 >API Guides</a></li> 450 <li class="reference"><a href="/reference/packages.html" 451 zh-tw-lang="參考資源" 452 zh-cn-lang="参考" 453 ru-lang="Справочник" 454 ko-lang="참조문서" 455 ja-lang="リファレンス" 456 es-lang="Referencia" 457 >Reference</a></li> 458 <li class="tools"><a href="/sdk/index.html" 459 zh-tw-lang="相關工具" 460 zh-cn-lang="工具" 461 ru-lang="Инструменты" 462 ko-lang="도구" 463 ja-lang="ツール" 464 es-lang="Herramientas" 465 >Tools</a></li> 466 <li class="google"><a href="/google/index.html" 467 >Google Services</a> 468 </li> 469 470 <li class="samples"><a href="/samples/index.html" 471 >Samples</a> 472 </li> 473 474 </ul> 475 </div> 476 </div> 477 <!-- /Sendondary x-nav DEVELOP --> 478 479 480 481 <div id="searchResults" class="wrap" style="display:none;"> 482 <h2 id="searchTitle">Results</h2> 483 <div id="leftSearchControl" class="search-control">Loading...</div> 484 </div> 485 </div> <!--end header-wrapper --> 486 487 <div id="sticky-header"> 488 <div> 489 <a class="logo" href="#top"></a> 490 <a class="top" href="#top"></a> 491 <ul class="breadcrumb"> 492 493 <li class="current">Promotion</li> 494 </ul> 495 </div> 496 </div> 497 498 499 500 501 502 503 <div class="wrap clearfix" id="body-content"> 504 <div class="col-4" id="side-nav" itemscope itemtype="http://schema.org/SiteNavigationElement"> 505 <div id="devdoc-nav" class="scroll-pane"> 506 507 508 509<ul id="nav"> 510 511 <li class="nav-section"> 512 <div class="nav-section-header empty"><a href="/google/index.html"> 513 <span class="en">Overview</span> 514 </a></div> 515 </li> 516 517 <li class="nav-section"> 518 <div class="nav-section-header empty"><a href="/google/play-services/games.html"> 519 <span class="en">Games</span> 520 </a></div> 521 </li> 522 <li class="nav-section"> 523 <div class="nav-section-header empty"><a href="/google/play-services/location.html"> 524 <span class="en">Location</span> 525 </a></div> 526 </li> 527 <li class="nav-section"> 528 <div class="nav-section-header empty"><a href="/google/play-services/plus.html"> 529 <span class="en">Google+</span> 530 </a></div> 531 </li> 532 <li class="nav-section"> 533 <div class="nav-section-header empty"><a href="/google/play-services/maps.html"> 534 <span class="en">Maps</span> 535 </a></div> 536 </li> 537 <li class="nav-section"> 538 <div class="nav-section-header empty"><a href="/google/play-services/drive.html"> 539 <span class="en">Drive</span> 540 </a></div> 541 </li> 542 <li class="nav-section"> 543 <div class="nav-section-header empty"><a href="/google/play-services/cast.html"> 544 <span class="en">Cast</span> 545 </a></div> 546 </li> 547 <li class="nav-section"> 548 <div class="nav-section-header"><a href="/google/play-services/ads.html"> 549 <span class="en">Ads</span></a> 550 </div> 551 <ul> 552 <li><a href="/google/play-services/id.html"> 553 <span class="en">Advertising ID</span></a> 554 </li> 555 </ul> 556 </li> 557 <li class="nav-section"> 558 <div class="nav-section-header empty"><a href="/google/play-services/wallet.html"> 559 <span class="en">Wallet</span> 560 </a></div> 561 </li> 562 563 564 <li class="nav-section"> 565 <div class="nav-section-header"><a href="/google/play-services/index.html"> 566 <span class="en">Google Play Services</span></a> 567 </div> 568 <ul> 569 <li><a href="/google/play-services/setup.html"> 570 <span class="en">Setting Up Google Play Services</span></a> 571 </li> 572 <li class="nav-section"> 573 <div class="nav-section-header"><a href="/google/auth/api-client.html"> 574 <span class="en">Accessing Google APIs</span></a> 575 </div> 576 <ul> 577 <li> 578 <a href="/google/auth/http-auth.html"> 579 <span class="en">Authorizing with Google for REST APIs</span> 580 </a> 581 </li> 582 </ul> 583 </li> 584 <li id="gms-tree-list" class="nav-section"> 585 <div class="nav-section-header"> 586 <a href="/reference/gms-packages.html"> 587 <span class="en">Reference</span> 588 </a> 589 <div> 590 </li> 591 </ul> 592 </li> 593 594 595 <li class="nav-section"> 596 <div class="nav-section-header"><a href="/google/play/billing/index.html"> 597 <span class="en">Google Play In-app Billing</span></a> 598 </div> 599 <ul> 600 <li><a href="/google/play/billing/billing_overview.html"> 601 <span class="en">Overview</span></a> 602 </li> 603 <li class="nav-section"><div class="nav-section-header"><a href="/google/play/billing/api.html"> 604 <span class="en">Version 3 API</span></a></div> 605 <ul> 606 <li><a href="/google/play/billing/billing_integrate.html"> 607 <span class="en">Implementing the API</span></a></li> 608 <li><a href="/google/play/billing/billing_reference.html"> 609 <span class="en">Reference</span></a></li> 610 </ul> 611 </li> 612 <li class="nav-section"><div class="nav-section-header"><a href="/google/play/billing/v2/api.html"> 613 <span class="en">Version 2 API</span></a></div> 614 <ul> 615 <li><a href="/google/play/billing/v2/billing_integrate.html"> 616 <span class="en">Implementing the API</span></a></li> 617 <li><a href="/google/play/billing/v2/billing_subscriptions.html"> 618 <span class="en">Subscriptions</span></a></li> 619 <li><a href="/google/play/billing/v2/billing_reference.html"> 620 <span class="en">Reference</span></a></li> 621 </ul> 622 </li> 623 <li><a href="/google/play/billing/billing_subscriptions.html"> 624 <span class="en">Subscriptions</span></a> 625 </li> 626 <li><a href="/google/play/billing/billing_best_practices.html"> 627 <span class="en">Security and Design</span></a> 628 </li> 629 <li><a href="/google/play/billing/billing_testing.html"> 630 <span class="en">Testing In-app Billing</span></a> 631 </li> 632 <li><a href="/google/play/billing/billing_admin.html"> 633 <span class="en">Administering In-app Billing</span></a> 634 </li> 635 <li><a href="/google/play/billing/versions.html"> 636 <span class="en">Version Notes</span></a> 637 </li> 638 </ul> 639 </li> 640 641 642 643 <li class="nav-section"> 644 <div class="nav-section-header"><a href="/google/gcm/index.html"> 645 <span class="en">Google Cloud Messaging</span></a> 646 </div> 647 <ul> 648 <li><a href="/google/gcm/gcm.html"> 649 <span class="en">Overview</span></a> 650 </li> 651 <li><a href="/google/gcm/gs.html"> 652 <span class="en">Getting Started</span></a> 653 </li> 654 <li><a href="/google/gcm/client.html"> 655 <span class="en">Implementing GCM Client</span></a> 656 </li> 657 <li class="nav-section"><div class="nav-section-header"><a href="/google/gcm/server.html"> 658 <span class="en">Implementing GCM Server</span></a></div> 659 <ul> 660 <li><a href="/google/gcm/ccs.html"> 661 <span class="en">CCS (XMPP)</span></a></li> 662 <li><a href="/google/gcm/http.html"> 663 <span class="en">HTTP</span></a></li> 664 </ul> 665 </li> 666 <li><a href="/google/gcm/notifications.html"> 667 <span class="en">User Notifications</span></a> 668 </li> 669 <li><a href="/google/gcm/adv.html"> 670 <span class="en">Advanced Topics</span></a> 671 </li> 672 <li><a href="/google/gcm/c2dm.html"> 673 <span class="en">Migration</span></a> 674 </li> 675 <li id="gcm-tree-list" class="nav-section"> 676 <div class="nav-section-header"> 677 <a href="/reference/gcm-packages.html"> 678 <span class="en">Reference</span> 679 </a> 680 <div> 681 </li> 682 </ul> 683 </li> 684 685 <li class="nav-section"> 686 <div class="nav-section-header empty"><a href="/google/gcs/index.html"> 687 <span class="en">Google Cloud Save</span></a> 688 </div> 689 </li> 690 691 <li class="nav-section"> 692 <div class="nav-section-header"><a href="/google/play/dist.html"> 693 <span class="en">Google Play Distribution</span></a> 694 </div> 695 <ul> 696 <li><a href="/google/play/filters.html"> 697 <span class="en">Filters on Google Play</span></a> 698 </li> 699 <li><a href="/google/play/billing/gp-purchase-status-api.html"> 700 <span class="en">Google Play Developer API</span></a> 701 </li> 702 <li><a href="/google/play/publishing/multiple-apks.html"> 703 <span class="en">Multiple APK Support</span></a> 704 </li> 705 <li><a href="/google/play/expansion-files.html"> 706 <span class="en">APK Expansion Files</span></a> 707 </li> 708 <li class="nav-section"> 709 <div class="nav-section-header"><a href="/google/play/licensing/index.html"> 710 <span class="en">Application Licensing</span></a> 711 </div> 712 <ul> 713 <li><a href="/google/play/licensing/overview.html"> 714 <span class="en">Licensing Overview</span></a> 715 </li> 716 <li><a href="/google/play/licensing/setting-up.html"> 717 <span class="en">Setting Up for Licensing</span></a> 718 </li> 719 <li><a href="/google/play/licensing/adding-licensing.html"> 720 <span class="en">Adding Licensing to Your App</span></a> 721 </li> 722 <li><a href="/google/play/licensing/licensing-reference.html"> 723 <span class="en">Licensing Reference</span></a> 724 </li> 725 </ul> 726 </li> 727 728 <li class="nav-section"> 729 <div class="nav-section-header"><a href="/google/backup/index.html"> 730 Android Backup Service</a> 731 </div> 732 <ul> 733 <li><a href="/google/backup/signup.html"> 734 Register</a> 735 </li> 736 </ul> 737 </li> 738 739 </ul> 740 741</li> 742 743 744 745</ul> 746 747<script type="text/javascript"> 748<!-- 749 buildToggleLists(); 750 changeNavLang(getLangPref()); 751//--> 752</script> 753 754 755 756 757 </div> 758 <script type="text/javascript"> 759 showGoogleRefTree(); 760 761 </script> 762 </div> <!-- end side-nav --> 763 <script> 764 $(document).ready(function() { 765 scrollIntoView("devdoc-nav"); 766 }); 767 </script> 768 769 770 771 772 773 774<div class="col-12" id="doc-col"> 775 776<div id="api-info-block"> 777 778 779 780 781 782 783 784 785 786 787 788<div class="sum-details-links"> 789 790Summary: 791 792 793 794 795 796 <a href="#constants">Constants</a> 797 798 799 800 801 802 803 | <a href="#pubctors">Ctors</a> 804 805 806 807 808 | <a href="#pubmethods">Methods</a> 809 810 811 812 813 | <a href="#inhmethods">Inherited Methods</a> 814 815| <a href="#" onclick="return toggleAllClassInherited()" id="toggleAllClassInherited">[Expand All]</a> 816 817</div><!-- end sum-details-links --> 818<div class="api-level"> 819 820 821 822 823</div> 824</div><!-- end api-info-block --> 825 826 827<!-- ======== START OF CLASS DATA ======== --> 828 829<div id="jd-header"> 830 public 831 832 833 834 class 835<h1 itemprop="name">Promotion</h1> 836 837 838 839 840 extends Object<br/> 841 842 843 844 845 846 847 848 849 850 851 852 853</div><!-- end header --> 854 855<div id="naMessage"></div> 856 857<div id="jd-content" class="api apilevel-"> 858<table class="jd-inheritance-table"> 859 860 861 <tr> 862 863 <td colspan="2" class="jd-inheritance-class-cell">java.lang.Object</td> 864 </tr> 865 866 867 <tr> 868 869 <td class="jd-inheritance-space"> ↳</td> 870 871 <td colspan="1" class="jd-inheritance-class-cell">com.google.android.gms.analytics.ecommerce.Promotion</td> 872 </tr> 873 874 875</table> 876 877 878 879 880 881 882 883<div class="jd-descr"> 884 885 886<h2>Class Overview</h2> 887<p itemprop="articleBody">Class to construct promotion related fields for Google Analytics hits. The fields from this class 888 can be used to represent internal promotions that run within an app, such as banners, banner ads 889 etc. 890 891 Typical usage: 892 <p> 893 <pre> 894 ScreenViewBuilder builder = new HitBuilders.ScreenViewBuilder(); 895 896 builder.setPromotionAction(Promotion.ACTION_CLICK) 897 .addPromotion(new Promotion().setId("PROMO-ID1234").setName("Home screen banner.")) 898 tracker.send(builder.build()); 899 </pre> 900 </p> 901</p> 902 903 904 905 906 907</div><!-- jd-descr --> 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924<div class="jd-descr"> 925 926 927<h2>Summary</h2> 928 929 930 931 932 933 934 935 936 937 938 939 940 941<!-- =========== ENUM CONSTANT SUMMARY =========== --> 942<table id="constants" class="jd-sumtable"><tr><th colspan="12">Constants</th></tr> 943 944 945 946 <tr class="alt-color api apilevel-" > 947 <td class="jd-typecol">String</td> 948 <td class="jd-linkcol"><a href="/reference/com/google/android/gms/analytics/ecommerce/Promotion.html#ACTION_CLICK">ACTION_CLICK</a></td> 949 <td class="jd-descrcol" width="100%"> 950 Action to use when the user clicks/taps on a promotion. 951 952 953 954 </td> 955 </tr> 956 957 958 <tr class=" api apilevel-" > 959 <td class="jd-typecol">String</td> 960 <td class="jd-linkcol"><a href="/reference/com/google/android/gms/analytics/ecommerce/Promotion.html#ACTION_VIEW">ACTION_VIEW</a></td> 961 <td class="jd-descrcol" width="100%"> 962 Action to use when the user views a promotion. 963 964 965 966 </td> 967 </tr> 968 969 970 971</table> 972 973 974 975 976 977 978 979 980 981 982 983 984<!-- ======== CONSTRUCTOR SUMMARY ======== --> 985<table id="pubctors" class="jd-sumtable"><tr><th colspan="12">Public Constructors</th></tr> 986 987 988 989 990 <tr class="alt-color api apilevel-" > 991 <td class="jd-typecol"><nobr> 992 993 994 995 996 997 </nobr> 998 </td> 999 <td class="jd-linkcol" width="100%"><nobr> 1000 <span class="sympad"><a href="/reference/com/google/android/gms/analytics/ecommerce/Promotion.html#Promotion()">Promotion</a></span>()</nobr> 1001 1002 </td></tr> 1003 1004 1005 1006</table> 1007 1008 1009 1010 1011 1012 1013<!-- ========== METHOD SUMMARY =========== --> 1014<table id="pubmethods" class="jd-sumtable"><tr><th colspan="12">Public Methods</th></tr> 1015 1016 1017 1018 1019 <tr class="alt-color api apilevel-" > 1020 <td class="jd-typecol"><nobr> 1021 1022 1023 1024 1025 1026 <a href="/reference/com/google/android/gms/analytics/ecommerce/Promotion.html">Promotion</a></nobr> 1027 </td> 1028 <td class="jd-linkcol" width="100%"><nobr> 1029 <span class="sympad"><a href="/reference/com/google/android/gms/analytics/ecommerce/Promotion.html#setCreative(java.lang.String)">setCreative</a></span>(String value)</nobr> 1030 1031 <div class="jd-descrdiv"> 1032 Sets the name of the creative associated with the promotion. 1033 1034 1035 1036 </div> 1037 1038 </td></tr> 1039 1040 1041 1042 <tr class=" api apilevel-" > 1043 <td class="jd-typecol"><nobr> 1044 1045 1046 1047 1048 1049 <a href="/reference/com/google/android/gms/analytics/ecommerce/Promotion.html">Promotion</a></nobr> 1050 </td> 1051 <td class="jd-linkcol" width="100%"><nobr> 1052 <span class="sympad"><a href="/reference/com/google/android/gms/analytics/ecommerce/Promotion.html#setId(java.lang.String)">setId</a></span>(String value)</nobr> 1053 1054 <div class="jd-descrdiv"> 1055 Sets the id that is used to identify a promotion in GA reports. 1056 1057 1058 1059 </div> 1060 1061 </td></tr> 1062 1063 1064 1065 <tr class="alt-color api apilevel-" > 1066 <td class="jd-typecol"><nobr> 1067 1068 1069 1070 1071 1072 <a href="/reference/com/google/android/gms/analytics/ecommerce/Promotion.html">Promotion</a></nobr> 1073 </td> 1074 <td class="jd-linkcol" width="100%"><nobr> 1075 <span class="sympad"><a href="/reference/com/google/android/gms/analytics/ecommerce/Promotion.html#setName(java.lang.String)">setName</a></span>(String value)</nobr> 1076 1077 <div class="jd-descrdiv"> 1078 Sets the name that is used to identify the promotion in GA reports. 1079 1080 1081 1082 </div> 1083 1084 </td></tr> 1085 1086 1087 1088 <tr class=" api apilevel-" > 1089 <td class="jd-typecol"><nobr> 1090 1091 1092 1093 1094 1095 <a href="/reference/com/google/android/gms/analytics/ecommerce/Promotion.html">Promotion</a></nobr> 1096 </td> 1097 <td class="jd-linkcol" width="100%"><nobr> 1098 <span class="sympad"><a href="/reference/com/google/android/gms/analytics/ecommerce/Promotion.html#setPosition(java.lang.String)">setPosition</a></span>(String value)</nobr> 1099 1100 <div class="jd-descrdiv"> 1101 Sets the position of the promotion. 1102 1103 1104 1105 </div> 1106 1107 </td></tr> 1108 1109 1110 1111</table> 1112 1113 1114 1115 1116 1117 1118 1119<!-- ========== METHOD SUMMARY =========== --> 1120<table id="inhmethods" class="jd-sumtable"><tr><th> 1121 <a href="#" class="toggle-all" onclick="return toggleAllInherited(this, null)">[Expand]</a> 1122 <div style="clear:left;">Inherited Methods</div></th></tr> 1123 1124 1125<tr class="api apilevel-" > 1126<td colspan="12"> 1127 <a href="#" onclick="return toggleInherited(this, null)" id="inherited-methods-java.lang.Object" class="jd-expando-trigger closed" 1128 ><img id="inherited-methods-java.lang.Object-trigger" 1129 src="/assets/images/triangle-closed.png" 1130 class="jd-expando-trigger-img" /></a> 1131From class 1132 1133 java.lang.Object 1134 1135<div id="inherited-methods-java.lang.Object"> 1136 <div id="inherited-methods-java.lang.Object-list" 1137 class="jd-inheritedlinks"> 1138 </div> 1139 <div id="inherited-methods-java.lang.Object-summary" style="display: none;"> 1140 <table class="jd-sumtable-expando"> 1141 1142 1143 1144 1145 <tr class="alt-color api apilevel-" > 1146 <td class="jd-typecol"><nobr> 1147 1148 1149 1150 1151 1152 Object</nobr> 1153 </td> 1154 <td class="jd-linkcol" width="100%"><nobr> 1155 <span class="sympad">clone</span>()</nobr> 1156 1157 </td></tr> 1158 1159 1160 1161 <tr class=" api apilevel-" > 1162 <td class="jd-typecol"><nobr> 1163 1164 1165 1166 1167 1168 boolean</nobr> 1169 </td> 1170 <td class="jd-linkcol" width="100%"><nobr> 1171 <span class="sympad">equals</span>(Object arg0)</nobr> 1172 1173 </td></tr> 1174 1175 1176 1177 <tr class="alt-color api apilevel-" > 1178 <td class="jd-typecol"><nobr> 1179 1180 1181 1182 1183 1184 void</nobr> 1185 </td> 1186 <td class="jd-linkcol" width="100%"><nobr> 1187 <span class="sympad">finalize</span>()</nobr> 1188 1189 </td></tr> 1190 1191 1192 1193 <tr class=" api apilevel-" > 1194 <td class="jd-typecol"><nobr> 1195 1196 1197 final 1198 1199 1200 Class<?></nobr> 1201 </td> 1202 <td class="jd-linkcol" width="100%"><nobr> 1203 <span class="sympad">getClass</span>()</nobr> 1204 1205 </td></tr> 1206 1207 1208 1209 <tr class="alt-color api apilevel-" > 1210 <td class="jd-typecol"><nobr> 1211 1212 1213 1214 1215 1216 int</nobr> 1217 </td> 1218 <td class="jd-linkcol" width="100%"><nobr> 1219 <span class="sympad">hashCode</span>()</nobr> 1220 1221 </td></tr> 1222 1223 1224 1225 <tr class=" api apilevel-" > 1226 <td class="jd-typecol"><nobr> 1227 1228 1229 final 1230 1231 1232 void</nobr> 1233 </td> 1234 <td class="jd-linkcol" width="100%"><nobr> 1235 <span class="sympad">notify</span>()</nobr> 1236 1237 </td></tr> 1238 1239 1240 1241 <tr class="alt-color api apilevel-" > 1242 <td class="jd-typecol"><nobr> 1243 1244 1245 final 1246 1247 1248 void</nobr> 1249 </td> 1250 <td class="jd-linkcol" width="100%"><nobr> 1251 <span class="sympad">notifyAll</span>()</nobr> 1252 1253 </td></tr> 1254 1255 1256 1257 <tr class=" api apilevel-" > 1258 <td class="jd-typecol"><nobr> 1259 1260 1261 1262 1263 1264 String</nobr> 1265 </td> 1266 <td class="jd-linkcol" width="100%"><nobr> 1267 <span class="sympad">toString</span>()</nobr> 1268 1269 </td></tr> 1270 1271 1272 1273 <tr class="alt-color api apilevel-" > 1274 <td class="jd-typecol"><nobr> 1275 1276 1277 final 1278 1279 1280 void</nobr> 1281 </td> 1282 <td class="jd-linkcol" width="100%"><nobr> 1283 <span class="sympad">wait</span>()</nobr> 1284 1285 </td></tr> 1286 1287 1288 1289 <tr class=" api apilevel-" > 1290 <td class="jd-typecol"><nobr> 1291 1292 1293 final 1294 1295 1296 void</nobr> 1297 </td> 1298 <td class="jd-linkcol" width="100%"><nobr> 1299 <span class="sympad">wait</span>(long arg0, int arg1)</nobr> 1300 1301 </td></tr> 1302 1303 1304 1305 <tr class="alt-color api apilevel-" > 1306 <td class="jd-typecol"><nobr> 1307 1308 1309 final 1310 1311 1312 void</nobr> 1313 </td> 1314 <td class="jd-linkcol" width="100%"><nobr> 1315 <span class="sympad">wait</span>(long arg0)</nobr> 1316 1317 </td></tr> 1318 1319 1320</table> 1321 </div> 1322</div> 1323</td></tr> 1324 1325 1326</table> 1327 1328 1329</div><!-- jd-descr (summary) --> 1330 1331<!-- Details --> 1332 1333 1334 1335 1336 1337 1338 1339 1340<!-- XML Attributes --> 1341 1342 1343<!-- Enum Values --> 1344 1345 1346<!-- Constants --> 1347 1348 1349<!-- ========= ENUM CONSTANTS DETAIL ======== --> 1350<h2>Constants</h2> 1351 1352 1353 1354 1355<A NAME="ACTION_CLICK"></A> 1356 1357<div class="jd-details api apilevel-"> 1358 <h4 class="jd-details-title"> 1359 <span class="normal"> 1360 public 1361 static 1362 final 1363 String 1364 </span> 1365 ACTION_CLICK 1366 </h4> 1367 <div class="api-level"> 1368 1369 1370 1371 1372 </div> 1373 <div class="jd-details-descr"> 1374 1375 1376 1377 1378 <div class="jd-tagdata jd-tagdescr"><p>Action to use when the user clicks/taps on a promotion. 1379</p></div> 1380 1381 1382 <div class="jd-tagdata"> 1383 <span class="jd-tagtitle">Constant Value: </span> 1384 <span> 1385 1386 "click" 1387 1388 </span> 1389 </div> 1390 1391 </div> 1392</div> 1393 1394 1395 1396<A NAME="ACTION_VIEW"></A> 1397 1398<div class="jd-details api apilevel-"> 1399 <h4 class="jd-details-title"> 1400 <span class="normal"> 1401 public 1402 static 1403 final 1404 String 1405 </span> 1406 ACTION_VIEW 1407 </h4> 1408 <div class="api-level"> 1409 1410 1411 1412 1413 </div> 1414 <div class="jd-details-descr"> 1415 1416 1417 1418 1419 <div class="jd-tagdata jd-tagdescr"><p>Action to use when the user views a promotion. 1420</p></div> 1421 1422 1423 <div class="jd-tagdata"> 1424 <span class="jd-tagtitle">Constant Value: </span> 1425 <span> 1426 1427 "view" 1428 1429 </span> 1430 </div> 1431 1432 </div> 1433</div> 1434 1435 1436 1437 1438<!-- Fields --> 1439 1440 1441<!-- Public ctors --> 1442 1443 1444<!-- ========= CONSTRUCTOR DETAIL ======== --> 1445<h2>Public Constructors</h2> 1446 1447 1448 1449<A NAME="Promotion()"></A> 1450 1451<div class="jd-details api apilevel-"> 1452 <h4 class="jd-details-title"> 1453 <span class="normal"> 1454 public 1455 1456 1457 1458 1459 1460 </span> 1461 <span class="sympad">Promotion</span> 1462 <span class="normal">()</span> 1463 </h4> 1464 <div class="api-level"> 1465 <div></div> 1466 1467 1468 1469 </div> 1470 <div class="jd-details-descr"> 1471 1472 1473 1474 1475 <div class="jd-tagdata jd-tagdescr"><p></p></div> 1476 1477 </div> 1478</div> 1479 1480 1481 1482 1483 1484<!-- ========= CONSTRUCTOR DETAIL ======== --> 1485<!-- Protected ctors --> 1486 1487 1488 1489<!-- ========= METHOD DETAIL ======== --> 1490<!-- Public methdos --> 1491 1492<h2>Public Methods</h2> 1493 1494 1495 1496<A NAME="setCreative(java.lang.String)"></A> 1497 1498<div class="jd-details api apilevel-"> 1499 <h4 class="jd-details-title"> 1500 <span class="normal"> 1501 public 1502 1503 1504 1505 1506 <a href="/reference/com/google/android/gms/analytics/ecommerce/Promotion.html">Promotion</a> 1507 </span> 1508 <span class="sympad">setCreative</span> 1509 <span class="normal">(String value)</span> 1510 </h4> 1511 <div class="api-level"> 1512 <div></div> 1513 1514 1515 1516 </div> 1517 <div class="jd-details-descr"> 1518 1519 1520 1521 1522 <div class="jd-tagdata jd-tagdescr"><p>Sets the name of the creative associated with the promotion.</p></div> 1523 <div class="jd-tagdata"> 1524 <h5 class="jd-tagtitle">Parameters</h5> 1525 <table class="jd-tagtable"> 1526 <tr> 1527 <th>value</td> 1528 <td>The promotion creative's name. Example: "Cool pets creative"</td> 1529 </tr> 1530 </table> 1531 </div> 1532 <div class="jd-tagdata"> 1533 <h5 class="jd-tagtitle">Returns</h5> 1534 <ul class="nolist"><li>Returns the same object to enable chaining of methods. 1535</li></ul> 1536 </div> 1537 1538 </div> 1539</div> 1540 1541 1542<A NAME="setId(java.lang.String)"></A> 1543 1544<div class="jd-details api apilevel-"> 1545 <h4 class="jd-details-title"> 1546 <span class="normal"> 1547 public 1548 1549 1550 1551 1552 <a href="/reference/com/google/android/gms/analytics/ecommerce/Promotion.html">Promotion</a> 1553 </span> 1554 <span class="sympad">setId</span> 1555 <span class="normal">(String value)</span> 1556 </h4> 1557 <div class="api-level"> 1558 <div></div> 1559 1560 1561 1562 </div> 1563 <div class="jd-details-descr"> 1564 1565 1566 1567 1568 <div class="jd-tagdata jd-tagdescr"><p>Sets the id that is used to identify a promotion in GA reports.</p></div> 1569 <div class="jd-tagdata"> 1570 <h5 class="jd-tagtitle">Parameters</h5> 1571 <table class="jd-tagtable"> 1572 <tr> 1573 <th>value</td> 1574 <td>The promotion's id.</td> 1575 </tr> 1576 </table> 1577 </div> 1578 <div class="jd-tagdata"> 1579 <h5 class="jd-tagtitle">Returns</h5> 1580 <ul class="nolist"><li>Returns the same object to enable chaining of methods. 1581</li></ul> 1582 </div> 1583 1584 </div> 1585</div> 1586 1587 1588<A NAME="setName(java.lang.String)"></A> 1589 1590<div class="jd-details api apilevel-"> 1591 <h4 class="jd-details-title"> 1592 <span class="normal"> 1593 public 1594 1595 1596 1597 1598 <a href="/reference/com/google/android/gms/analytics/ecommerce/Promotion.html">Promotion</a> 1599 </span> 1600 <span class="sympad">setName</span> 1601 <span class="normal">(String value)</span> 1602 </h4> 1603 <div class="api-level"> 1604 <div></div> 1605 1606 1607 1608 </div> 1609 <div class="jd-details-descr"> 1610 1611 1612 1613 1614 <div class="jd-tagdata jd-tagdescr"><p>Sets the name that is used to identify the promotion in GA reports.</p></div> 1615 <div class="jd-tagdata"> 1616 <h5 class="jd-tagtitle">Parameters</h5> 1617 <table class="jd-tagtable"> 1618 <tr> 1619 <th>value</td> 1620 <td>The promotion's name. Example: "Home Banner"</td> 1621 </tr> 1622 </table> 1623 </div> 1624 <div class="jd-tagdata"> 1625 <h5 class="jd-tagtitle">Returns</h5> 1626 <ul class="nolist"><li>Returns the same object to enable chaining of methods. 1627</li></ul> 1628 </div> 1629 1630 </div> 1631</div> 1632 1633 1634<A NAME="setPosition(java.lang.String)"></A> 1635 1636<div class="jd-details api apilevel-"> 1637 <h4 class="jd-details-title"> 1638 <span class="normal"> 1639 public 1640 1641 1642 1643 1644 <a href="/reference/com/google/android/gms/analytics/ecommerce/Promotion.html">Promotion</a> 1645 </span> 1646 <span class="sympad">setPosition</span> 1647 <span class="normal">(String value)</span> 1648 </h4> 1649 <div class="api-level"> 1650 <div></div> 1651 1652 1653 1654 </div> 1655 <div class="jd-details-descr"> 1656 1657 1658 1659 1660 <div class="jd-tagdata jd-tagdescr"><p>Sets the position of the promotion.</p></div> 1661 <div class="jd-tagdata"> 1662 <h5 class="jd-tagtitle">Parameters</h5> 1663 <table class="jd-tagtable"> 1664 <tr> 1665 <th>value</td> 1666 <td>The promotion's position. Example: "top" or "bottom".</td> 1667 </tr> 1668 </table> 1669 </div> 1670 <div class="jd-tagdata"> 1671 <h5 class="jd-tagtitle">Returns</h5> 1672 <ul class="nolist"><li>Returns the same object to enable chaining of methods. 1673</li></ul> 1674 </div> 1675 1676 </div> 1677</div> 1678 1679 1680 1681 1682 1683<!-- ========= METHOD DETAIL ======== --> 1684 1685 1686 1687<!-- ========= END OF CLASS DATA ========= --> 1688<A NAME="navbar_top"></A> 1689 1690<div id="footer" class="wrap" > 1691 1692 1693 <div id="copyright"> 1694 1695 Except as noted, this content is licensed under <a 1696 href="http://www.apache.org/licenses/LICENSE-2.0">Apache 2.0</a>. 1697 For details and restrictions, see the <a href="/license.html"> 1698 Content License</a>. 1699 </div> 1700 <div id="build_info"> 1701 1702<script src="/timestamp.js" type="text/javascript"></script> 1703<script>document.write(BUILD_TIMESTAMP)</script> 1704 1705 </div> 1706 1707 1708 <div id="footerlinks"> 1709 1710 <p> 1711 <a href="/about/index.html">About Android</a> | 1712 <a href="/legal.html">Legal</a> | 1713 <a href="/support.html">Support</a> 1714 </p> 1715 </div> 1716 1717</div> <!-- end footer --> 1718</div> <!-- jd-content --> 1719 1720</div><!-- end doc-content --> 1721 1722</div> <!-- end body-content --> 1723 1724 1725 1726 1727 1728 1729</body> 1730</html> 1731
