การติดตั้งใช้งาน AFS ที่มาพร้อมเครื่องสำหรับ Android

นอกจากนี้ SDK โฆษณาในอุปกรณ์เคลื่อนที่ของ Google ยังรองรับสไตล์โฆษณาที่กำหนดเองในเครือข่ายการค้นหาด้วย หากแอปของคุณใช้ SDK โฆษณาในอุปกรณ์เคลื่อนที่ของ Google อยู่แล้ว เราขอแนะนำให้ใช้เวอร์ชัน AFSMA SDK แทน

หากคุณจะอัปเกรดเป็นเวอร์ชัน 19.0.0 ขึ้นไปจาก 18.1.0 หรือเก่ากว่า โปรดดูคำแนะนำในการย้ายข้อมูล

ข้อกำหนดเบื้องต้น

คู่มือการติดตั้งใช้งานนี้จะถือว่าคุณคุ้นเคยกับสิ่งต่อไปนี้

• โฆษณาที่กำหนดเองในเครือข่ายการค้นหาของ AdSense ที่มีสไตล์โฆษณาที่กำหนดเองในเครือข่ายการค้นหา
• การพัฒนาแอป Android

นำเข้า SDK เนทีฟของ AFS

เพิ่ม SDK

หากต้องการเพิ่ม AFS Native SDK ลงในแอป ให้ทำดังนี้

เปิดไฟล์ build.gradle ในไดเรกทอรีโมดูลของแอปพลิเคชัน เพิ่มกฎการสร้างใหม่ในส่วน dependencies สำหรับ SDK เวอร์ชันล่าสุด:

dependencies {
  implementation 'com.google.android.gms:play-services-afs-native:19.0.3'
}

ตรวจสอบว่า build.gradle ระดับบนสุดมีการอ้างอิงไปยังที่เก็บ google() หรือไปยัง maven { url "https://maven.google.com" }

ทำตามวิธีการเหล่านี้เพื่อใส่ปลั๊กอิน Google Play Version Matcher ไว้ในโปรเจ็กต์ การใช้ปลั๊กอินนี้ทำให้เกิดข้อผิดพลาดในการสร้างแบบ Gradle เมื่อใช้ SDK แบบเนทีฟ AFS ร่วมกับบริการ Google Play เวอร์ชันที่เข้ากันไม่ได้แทนที่จะอนุญาตให้แอปสร้างขึ้น แต่อาจทำให้เกิดข้อขัดข้องเกี่ยวกับรันไทม์ หรือใช้ failOnVersionConflict() ResolutionStrategy กับโปรเจ็กต์เพื่อทำให้เกิดข้อผิดพลาดในการสร้างเมื่อใช้บริการ Google Play เวอร์ชันที่เข้ากันไม่ได้ในโปรเจ็กต์ของคุณ บันทึกการเปลี่ยนแปลงแล้วคลิก Sync Project with Gradle Files ในแถบเครื่องมือ

ใช้ AndroidX แทนไลบรารีการสนับสนุนของ Android

เริ่มตั้งแต่ SDK เวอร์ชัน 17.0.0 แอปของคุณต้องใช้ Jetpack (AndroidX) ไลบรารีแทนไลบรารีการสนับสนุนของ Android ข้อกำหนดความเข้ากันได้

• ตั้งค่า com.android.tools.build:gradle เป็น v3.2.1 ขึ้นไป
• โปรดตั้งค่า compileSdkVersion เป็น 28 ขึ้นไป
• อัปเดตแอปเพื่อใช้ Jetpack (AndroidX) โดยทำตามวิธีการในการย้ายข้อมูลไปยัง AndroidX

คลาส

หากต้องการแสดงโฆษณาเนทีฟ AFS ในแอป ให้ใช้ชั้นเรียนต่อไปนี้

SearchAdController

• คลาสนี้มีหน้าที่ขอโฆษณาแบบไม่พร้อมกัน การแคชและดึงโฆษณา และแสดงโฆษณา
• บริบทโฆษณาแต่ละบริบทต้องมี SearchAdController แยกต่างหาก เช่น หากคุณมีหน้าจอที่แสดงโฆษณาอยู่ข้างๆ รายการผลการค้นหา และอีกหน้าจอหนึ่งที่แสดงโฆษณาพร้อมกับรายละเอียดสำหรับผลิตภัณฑ์ที่เฉพาะเจาะจง คุณควรสร้างอินสแตนซ์ SearchAdController แยกกัน 2 รายการ สำหรับแต่ละกรณี
• ต้องระบุรหัสเว็บพร็อพเพอร์ตี้ (รหัสผู้เผยแพร่โฆษณา) รหัสสไตล์ เพื่อใช้กับโฆษณาที่ส่งกลับ และ SearchAdOptions Context ที่ให้ไว้ในเครื่องมือสร้างต้องเป็น Activity ซึ่งมี SearchAdController และตำแหน่งที่คุณจะวางโฆษณา View
• เรียก loadAds เพื่อระบุการค้นหาผู้ใช้ใหม่และเริ่มต้นคำขอโฆษณาแบบไม่พร้อมกัน ระบบจะล้างโฆษณาที่โหลดจากการเรียกไปยัง loadAds ครั้งก่อนออกจากแคชโฆษณาภายในเมื่อมีการเรียกใหม่
• สร้าง View ด้วย createAdView เพื่อแสดงครีเอทีฟโฆษณา
• เมื่อระบบโหลดโฆษณาแล้ว ให้เรียกใช้ populateAdView ด้วย View ที่สร้างขึ้นก่อนหน้านี้ด้วย createAdView เพื่อแสดงโฆษณาที่แคชไว้ใน View ดังกล่าว นอกเหนือจาก View ที่จะป้อนข้อมูลแล้ว โปรดระบุ adKey ซึ่งเป็นสตริงที่กำหนดเองเพื่อระบุโฆษณาอย่างไม่ซ้ำกัน ซึ่งจะเชื่อมโยงครีเอทีฟโฆษณาที่เจาะจงซึ่งส่งกลับมาจากแคชกับ adKey ดังกล่าว ดังนั้นเมื่อมีการส่ง adKey เดียวกันไปยังการเรียก populateAdView ในอนาคต ระบบจะส่งโฆษณาเดิมกลับมา ตัวอย่างเช่น หากมีการเรียกใช้ populateAdView เป็นครั้งแรกด้วย adKey="keyA" และแสดงผลโฆษณารองเท้าเดินป่า การเรียก populateAdView ด้วย adKey="keyA" แต่ละครั้งจะแสดงโฆษณาเดียวกันสำหรับรองเท้าเดินป่า (การเรียกใหม่ไปยัง loadAds จะล้างโฆษณาที่แคชและคีย์โฆษณาที่เกี่ยวข้องทั้งหมด)

SearchAdOptions

• ส่งออบเจ็กต์นี้ไปยังเครื่องมือสร้าง SearchAdController เพื่อปรับแต่งวิธีขอและแสดงโฆษณา เรียกใช้ build() บน SearchAdOptions.Builder เพื่อสร้างออบเจ็กต์ SearchAdOptions

View

• สร้างออบเจ็กต์ View เพื่อเก็บโฆษณาโดยเรียกใช้ createAdView() ใน SearchAdController แสดงโฆษณาได้สูงสุดครั้งละ 1 รายการ แต่คุณนำ View เดียวกันมาใช้เพื่อแสดงโฆษณาที่แตกต่างกันเมื่อเวลาผ่านไปได้

SearchAdRequest

• เรียกใช้เมธอด loadAds บน SearchAdController ด้วย SearchAdRequest เพื่อเริ่มคำขอโฆษณาแบบไม่พร้อมกัน เรียก build() บน SearchAdRequest.Builder เพื่อสร้างออบเจ็กต์ SearchAdRequest

AdListener

• ใช้อินเทอร์เฟซนี้และส่งไปยังเครื่องมือสร้าง SearchAdController เพื่อลงทะเบียนโค้ดเรียกกลับสำหรับหลายสถานะ
• หมายเหตุ: จะไม่มีการโทรหา AdListener คำขอที่ถูกยกเลิก (การโทรหา loadAds ที่ถูกขัดจังหวะโดยการโทรอื่นไปยัง loadAds ก่อนที่การโทรครั้งแรกจะได้รับการแก้ไข)

ตัวอย่างการใช้งาน

ตัวอย่างด้านล่างแสดงการสร้าง SearchAdController ในตัวอย่าง Activity

//  MainActivity.java implementation
//  (MainActivity is a subclass of Activity)

SearchAdController adController;
// adContainer where we will place our ads in this example.
ViewGroup adContainer;

protected void onCreate(Bundle bundle){
  super.onCreate(bundle);
  adContainer = (ViewGroup) findViewById(...);
  // Specify ad options (not required).
  SearchAdOptions.Builder adOptionsBuilder = new SearchAdOptions.Builder();
  adOptionsBuilder.setAdType(SearchAdOptions.AD_TYPE_TEXT);
  adOptionsBuilder.setPrefetch(true);
  adOptionsBuilder.setNumAdsRequested(3);
  // Provide a callback to trigger when ads are loaded.
  AdListener adListener = new AdListener() {
    public void onAdLoaded() {
      createAndShowAd();
    }
  };
  // Instantiate the SearchAdController.
  adController = new SearchAdController(this, "your-client-id", "your-style-id",
                                        adOptionsBuilder.build(), adListener);
}

เมื่อผู้ใช้เริ่มการค้นหา ให้สร้าง SearchAdRequest และเรียกใช้ loadAds ใน SearchAdController เพื่อเริ่มคำขอโฆษณาแบบไม่พร้อมกัน

// Create the request.
SearchAdRequest.Builder requestBuilder = new SearchAdRequest.Builder();
requestBuilder.setQuery("user query here");
// Load the ads.
adController.loadAds(requestBuilder.build());

ใช้โค้ดเรียกกลับ onAdLoaded เพื่อใส่โฆษณาที่โหลดลงในมุมมองโฆษณา

private void createAndShowAd() {
  // Create a new view that will contain the ad.
  View adView = adController.createAdView();
  // Attach the new view to the view hierarchy.
  adContainer.addView(adView);
  // Display the ad inside the adView. We need to provide an adKey to
  // indicate which ad is to be displayed in the adView. In this example, 
  // since we only have one ad, we can provide any constant string. However, 
  // if you intend to display multiple ads, each ad you wish to display
  // should be given a unique adKey of your choosing.
  adController.populateAdView(adView, "demoAd");
}

โฆษณาที่เกี่ยวข้องกับข้อความค้นหาที่ระบุจะปรากฏใน adView

การตรวจสอบข้อผิดพลาด

SearchAdController ต้องใช้ออบเจ็กต์ AdListener ที่มีเมธอด onAdLoaded() ในการแจ้งเตือนแอปว่าโฆษณาพร้อมแสดง นอกจากนี้ คุณควรใช้เมธอด onAdFailedToLoad() ด้วยเพื่อให้สามารถตรวจหาและแก้ไขข้อผิดพลาดได้ ตัวอย่างเช่น คุณอาจใช้ AdListener ต่อไปนี้เพื่อแก้ไขข้อบกพร่องของการใช้งาน

AdListener adListener = new AdListener() {
    public void onAdLoaded() {
        // Called when an ad is loaded.
        Toast.makeText(MainActivity.this, "Ad Loaded",
                Toast.LENGTH_SHORT).show();
        Log.d(MainActivity.class.getSimpleName(), "Ad Loaded");
    }

    public void onAdLeftApplication() {
        // Called when an ad leaves the application
        // (to go to the browser for example).
        Toast.makeText(MainActivity.this, "Ad Left Application",
                Toast.LENGTH_SHORT).show();
        Log.d(MainActivity.class.getSimpleName(), "Ad Left Application");
    }

    @Override
    public void onAdFailedToLoad(int errorCode) {
        // Called when an ad request failed.
        Toast.makeText(MainActivity.this, "Ad Failed to Load: " + errorCode,
                Toast.LENGTH_SHORT).show();
        Log.e(MainActivity.class.getSimpleName(), "Ad Failed to Load: " +
                errorCode);
    }
};

ค่าคงที่ที่ใช้ในเมธอดโค้ดเรียกกลับ onAdFailedToLoad() จะกำหนดไว้ใน AdListener