Android v4 (เดิม) - การเริ่มต้นใช้งาน

บทนำ

Google Tag Manager ช่วยให้นักพัฒนาแอปเปลี่ยนค่าการกำหนดค่าในแอปพลิเคชันบนมือถือได้โดยใช้อินเทอร์เฟซ Google Tag Manager โดยไม่ต้องสร้างและส่งไบนารีของแอปพลิเคชันไปยังมาร์เก็ตเพลสของแอปอีกครั้ง

ซึ่งจะเป็นประโยชน์สำหรับการจัดการค่าการกำหนดค่าหรือแฟล็กในแอปพลิเคชันที่คุณอาจต้องเปลี่ยนแปลงในอนาคต ซึ่งรวมถึงสิ่งต่อไปนี้

  • การตั้งค่า UI และสตริงการแสดงผลต่างๆ
  • ขนาด ตำแหน่ง หรือประเภทของโฆษณาที่แสดงในแอปพลิเคชัน
  • การตั้งค่าเกมต่างๆ

นอกจากนี้ ระบบยังอาจประเมินค่าการกำหนดค่าที่รันไทม์โดยใช้กฎ ซึ่งช่วยให้กำหนดค่าแบบไดนามิกได้ เช่น

  • การใช้ขนาดหน้าจอเพื่อกำหนดขนาดแบนเนอร์โฆษณา
  • การใช้ภาษาและสถานที่ตั้งเพื่อกำหนดค่าองค์ประกอบ UI

นอกจากนี้ Google Tag Manager ยังช่วยให้สามารถติดตั้งใช้งานแท็กติดตามและพิกเซลแบบไดนามิกในแอปพลิเคชันได้ด้วย นักพัฒนาแอปสามารถพุชเหตุการณ์สำคัญไปยังชั้นข้อมูลและตัดสินใจในภายหลังว่าจะเริ่มทำงานแท็กติดตามหรือพิกเซลใด

ก่อนที่คุณจะเริ่ม

ทำตามขั้นตอนต่อไปนี้ก่อนเริ่มใช้คู่มือเริ่มต้นใช้งานนี้

เมื่อทำตามขั้นตอนเหล่านี้เสร็จแล้ว ส่วนที่เหลือของคู่มือนี้จะแนะนำวิธี กำหนดค่าและใช้ Google Tag Manager ภายในแอปพลิเคชัน Android

เริ่มต้นใช้งาน

หลังจากทำตามคู่มือเริ่มต้นใช้งานนี้ คุณจะเข้าใจวิธีทำสิ่งต่อไปนี้

คู่มือนี้ใช้ข้อมูลโค้ดจากCute Animals แอปพลิเคชันตัวอย่างที่รวมอยู่ใน SDK บริการ Google Play ดูแหล่งข้อมูลทั้งหมดสำหรับโปรเจ็กต์นี้ได้ที่ <android-sdk-directory>/extras/google/google_play_services/tagmanager/cuteanimals

1. การเพิ่ม Google Tag Manager ลงในโปรเจ็กต์

วิธีเพิ่ม Google Tag Manager ลงในโปรเจ็กต์

  1. ตั้งค่า SDK บริการ Google Play
  2. หากคุณใช้ IDE อื่นที่ไม่ใช่ Android Studio ให้เพิ่มสิทธิ์ต่อไปนี้ลงในไฟล์ AndroidManifest.xml
    <!-- For TagManager SDK -->
    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
  3. หากต้องการเปิดใช้ InstallReferrerReceiver เพื่อเรียกใช้ Receiver ของ Google Analytics เพื่อตั้งค่าข้อมูลแคมเปญ ให้เพิ่มโค้ดต่อไปนี้ลงในไฟล์ AndroidManifest.xml
    <!-- Used for install referrer tracking-->
    <service android:name="com.google.android.gms.tagmanager.InstallReferrerService" />
    <receiver
      android:name="com.google.android.gms.tagmanager.InstallReferrerReceiver"
      android:exported="true">
      <intent-filter>
        <action android:name="com.android.vending.INSTALL_REFERRER" />
      </intent-filter>
    </receiver>

2. การเพิ่มไฟล์คอนเทนเนอร์เริ่มต้นลงในโปรเจ็กต์

Google Tag Manager จะใช้คอนเทนเนอร์เริ่มต้นในการเรียกใช้แอปพลิเคชันครั้งแรก ระบบจะหยุดใช้คอนเทนเนอร์เริ่มต้นทันทีที่แอปสามารถดึงข้อมูลคอนเทนเนอร์ใหม่ผ่านเครือข่ายได้

วิธีดาวน์โหลดและเพิ่มไบนารีของคอนเทนเนอร์เริ่มต้นลงในแอปพลิเคชัน

  1. ลงชื่อเข้าใช้อินเทอร์เฟซเว็บ Google Tag Manager
  2. เลือกเวอร์ชันของคอนเทนเนอร์ที่ต้องการดาวน์โหลด
  3. คลิกปุ่มดาวน์โหลดเพื่อเรียกข้อมูลไบนารีของคอนเทนเนอร์
  4. เพิ่มไฟล์ไบนารีของคอนเทนเนอร์ที่ดาวน์โหลดลงในโปรเจ็กต์เป็นทรัพยากรดิบ
    1. หากไม่มีโฟลเดอร์ย่อย raw ใน <project-root>/res/ ให้สร้างโฟลเดอร์ย่อยดังกล่าว
    2. เปลี่ยนชื่อไฟล์ไบนารีของคอนเทนเนอร์หากจำเป็น โดยประกอบด้วยตัวอักษรพิมพ์เล็ก ตัวเลข และขีดล่างเท่านั้น
    3. คัดลอกไฟล์ไบนารีของคอนเทนเนอร์ไปยังโฟลเดอร์ <project-root>/res/raw

แม้ว่าเราจะแนะนำให้ใช้ไฟล์ไบนารี แต่หากคอนเทนเนอร์ไม่มีกฎหรือแท็ก คุณอาจเลือกใช้ไฟล์ JSON แบบง่ายแทนได้

3. กำลังเริ่มต้น Google Tag Manager

วิธีเริ่มต้นใช้งาน Google Tag Manager ในแอปพลิเคชัน

  1. รับซิงเกิลตัน TagManager:
    TagManager tagManager = TagManager.getInstance(this);
  2. ใช้ TagManager ซิงเกิลตันเพื่อส่งคำขอโหลดคอนเทนเนอร์ โดยระบุรหัสคอนเทนเนอร์ Google Tag Manager และไฟล์คอนเทนเนอร์เริ่มต้น รหัสคอนเทนเนอร์ควรเป็นตัวพิมพ์ใหญ่และตรงกับรหัสคอนเทนเนอร์ในอินเทอร์เฟซเว็บของ Google Tag Manager ทุกประการ การเรียกใช้ loadContainerPreferNonDefault() จะไม่บล็อกและแสดงผล PendingResult ดังนี้
    PendingResult<ContainerHolder> pending =
            tagManager.loadContainerPreferNonDefault(CONTAINER_ID,
            R.raw.defaultcontainer_binary);
  3. ใช้ ResultCallback เพื่อแสดงผล ContainerHolder เมื่อโหลดเสร็จหรือหมดเวลา:
    // The onResult method will be called as soon as one of the following happens:
    //     1. a saved container is loaded
    //     2. if there is no saved container, a network container is loaded
    //     3. the 2-second timeout occurs
    pending.setResultCallback(new ResultCallback<ContainerHolder>() {
        @Override
        public void onResult(ContainerHolder containerHolder) {
            ContainerHolderSingleton.setContainerHolder(containerHolder);
            Container container = containerHolder.getContainer();
            if (!containerHolder.getStatus().isSuccess()) {
                Log.e("CuteAnimals", "failure loading container");
                displayErrorToUser(R.string.load_error);
                return;
            }
            ContainerLoadedCallback.registerCallbacksForContainer(container);
            containerHolder.setContainerAvailableListener(new ContainerLoadedCallback());
            startMainActivity();
        }
    }, TIMEOUT_FOR_CONTAINER_OPEN_MILLISECONDS, TimeUnit.MILLISECONDS);

    การสร้าง ContainerHolder Singleton

    คุณควรเก็บ ContainerHolder ไว้เพียงอินสแตนซ์เดียวต่อการเรียกใช้แอปพลิเคชันแต่ละครั้ง ด้วยเหตุนี้ ตัวอย่างข้างต้นจึงใช้คลาสยูทิลิตี ContainerHolderSingleton เพื่อจัดการการเข้าถึงอินสแตนซ์ ContainerHolder คลาส ContainerHolderSingleton จะมีลักษณะดังนี้

    package com.google.android.tagmanager.examples.cuteanimals;
    
    import com.google.android.gms.tagmanager.ContainerHolder;
    
    /**
     * Singleton to hold the GTM Container (since it should be only created once
     * per run of the app).
     */
    public class ContainerHolderSingleton {
        private static ContainerHolder containerHolder;
    
        /**
         * Utility class; don't instantiate.
         */
        private ContainerHolderSingleton() {
        }
    
        public static ContainerHolder getContainerHolder() {
            return containerHolder;
        }
    
        public static void setContainerHolder(ContainerHolder c) {
            containerHolder = c;
        }
    }

4. การรับค่าการกำหนดค่าจากคอนเทนเนอร์

เมื่อโหลดคอนเทนเนอร์แล้ว คุณจะดึงค่าการกำหนดค่าได้โดยใช้เมธอด Container.get<type>() ใดก็ได้ ค่าการกำหนดค่าจะกำหนดโดยใช้ตัวแปรคอลเล็กชันค่าของ Google Tag Manager ตัวอย่างเช่น เมธอดต่อไปนี้จะดึงข้อมูลสีล่าสุดที่เราตัดสินใจใช้สำหรับองค์ประกอบ UI และแสดงผลเป็นจำนวนเต็ม

/**
 * Returns an integer representing a color.
 */
private int getColor(String key) {
    return colorFromColorName(containerHolder.getContainer().getString(key));
}

โค้ดนี้จะทำ 2 อย่างเพื่อดึงชื่อสีจากคอนเทนเนอร์

  1. รับ Container จาก ContainerHolder โดยใช้ ContainerHolder.getContainer()
  2. รับค่าสีโดยใช้ Container.getString(key) ซึ่งคุณได้กำหนดคีย์และค่าไว้ในอินเทอร์เฟซเว็บของ Google Tag Manager

5. การพุชเหตุการณ์และค่าไปยัง dataLayer

นอกจากนี้ Google Tag Manager ยังมีdataLayerที่คุณสามารถพุชข้อมูลเกี่ยวกับแอปพลิเคชันซึ่งสามารถอ่านได้ในส่วนอื่นๆ ของแอปพลิเคชัน หรือใช้เพื่อเริ่มการทำงานของแท็กที่คุณกำหนดค่าไว้ในอินเทอร์เฟซเว็บของ Google Tag Manager

การพุชค่าไปยัง dataLayer

dataLayer มีเลเยอร์ความคงอยู่ซึ่งคุณสามารถใช้เพื่อจัดเก็บคู่คีย์-ค่าที่อาจต้องการใช้ในส่วนอื่นๆ ของแอปพลิเคชัน หรือเป็นอินพุตสำหรับแท็ก Google Tag Manager

หากต้องการพุชค่าไปยัง dataLayer ให้ทำตามรูปแบบต่อไปนี้

  1. รับซิงเกิลตัน DataLayer:
    DataLayer dataLayer = TagManager.getInstance(context).getDataLayer();
  2. พุชเหตุการณ์โดยใช้ DataLayer.push():
    // Put the image_name into the data layer for future use.
    TagManager.getInstance(this).getDataLayer().push(IMAGE_NAME_KEY, imageName);

หากต้องการรับค่าจาก dataLayer ให้ใช้ DataLayer.get(key)

การพุชเหตุการณ์ไปยัง dataLayer

การพุชเหตุการณ์ไปยัง dataLayer ช่วยให้คุณแยกโค้ดของแอปพลิเคชันออกจากแท็กที่อาจต้องการเริ่มทํางานเพื่อตอบสนองต่อเหตุการณ์เหล่านั้นได้

ตัวอย่างเช่น แทนที่จะฮาร์ดโค้ดการเรียกใช้การติดตามการดูหน้าจอของ Google Analytics ลงในแอปพลิเคชัน คุณสามารถพุชเหตุการณ์หน้าจอไปยัง dataLayer และกำหนดแท็กติดตามผ่านอินเทอร์เฟซเว็บของ Google Tag Manager ได้ ซึ่งจะช่วยให้คุณแก้ไขแท็กนั้นหรือเพิ่มแท็กอื่นๆ ที่ตอบสนองต่อเหตุการณ์ในหน้าจอได้โดยไม่ต้องอัปเดตโค้ดของแอปพลิเคชัน

หากต้องการพุชเหตุการณ์ไปยัง dataLayer ให้ทำตามรูปแบบต่อไปนี้

  1. รับซิงเกิลตัน DataLayer:
    DataLayer dataLayer = TagManager.getInstance(context).getDataLayer();
  2. พุชเหตุการณ์โดยใช้ DataLayer.pushEvent():
    dataLayer.pushEvent("openScreen", DataLayer.mapOf("screenName", screenName));

    DataLayer.mapOf() เป็นเมธอดอรรถประโยชน์ที่คุณใช้สร้างแผนที่ของคู่คีย์-ค่าได้อย่างง่ายดาย ซึ่งจะอัปเดต dataLayer พร้อมกับที่มีการพุชเหตุการณ์

6. การแสดงตัวอย่าง การแก้ไขข้อบกพร่อง และการเผยแพร่

ก่อนเผยแพร่เวอร์ชันของคอนเทนเนอร์ คุณควรดูตัวอย่างเพื่อตรวจสอบว่าคอนเทนเนอร์ทำงานตามที่ต้องการ Google Tag Manager ช่วยให้คุณดูตัวอย่างเวอร์ชันของคอนเทนเนอร์ได้โดยการสร้างลิงก์และคิวอาร์โค้ดในอินเทอร์เฟซเว็บ แล้วใช้ลิงก์และคิวอาร์โค้ดเหล่านั้นเพื่อเปิดแอปพลิเคชัน นอกจากนี้ คุณยังเปิดใช้โหมดการบันทึกแบบละเอียดเพื่อแก้ไขข้อบกพร่องของลักษณะการทำงานที่ไม่คาดคิดได้ด้วย

กำลังแสดงตัวอย่าง

หากต้องการดูตัวอย่างเวอร์ชันของคอนเทนเนอร์ ให้ทำตามขั้นตอนต่อไปนี้

  1. กำลังเพิ่ม Activity ตัวอย่างนี้ลงในไฟล์ AndroidManifest
    <!--  Add preview activity. -->
    <activity
        android:name="com.google.android.gms.tagmanager.PreviewActivity"
        android:label="@string/app_name"
        android:noHistory="true">  <!-- optional, removes the previewActivity from the activity stack. -->
        <intent-filter>
          <data android:scheme="tagmanager.c.com.google.android.tagmanager.examples.cuteanimals" />
          <action android:name="android.intent.action.VIEW" />
          <category android:name="android.intent.category.DEFAULT" />
          <category android:name="android.intent.category.BROWSABLE"/>
        </intent-filter>
    </activity>

    อย่าลืมแก้ไขบรรทัดนี้เพื่อใส่ชื่อแพ็กเกจของแอปพลิเคชัน

    <data android:scheme="tagmanager.c.com.google.android.tagmanager.examples.cuteanimals" />
  2. สร้างลิงก์ตัวอย่างในอินเทอร์เฟซเว็บของ Google Tag Manager
    1. ลงชื่อเข้าใช้ Google Tag Manager
    2. เลือกเวอร์ชันคอนเทนเนอร์ที่จะแสดงตัวอย่าง
    3. คลิกปุ่มตัวอย่าง
    4. ป้อนชื่อแพ็กเกจของแอปพลิเคชัน แล้วคลิกสร้างลิงก์เริ่มแสดงตัวอย่าง
  3. ใช้ลิงก์หรือคิวอาร์โค้ดที่สร้างขึ้นเพื่อเปิดแอปพลิเคชัน
  4. คุณออกจากโหมดแสดงตัวอย่างได้โดยไปที่ลิงก์ที่สร้างขึ้นโดยตัวเลือกสร้างลิงก์สิ้นสุดการแสดงตัวอย่างในอินเทอร์เฟซเว็บ

การแก้ไขข้อบกพร่อง

หากต้องการแก้ปัญหาการติดตั้งใช้งานคอนเทนเนอร์ ให้เปิดใช้การบันทึกแบบละเอียดโดยเรียกใช้ TagManager.setVerboseLoggingEnabled(true) ดังนี้

// Modify the log level of the logger to print out not only
// warning and error messages, but also verbose, debug, info messages.
tagManager.setVerboseLoggingEnabled(true);

การเผยแพร่

หลังจากดูตัวอย่างคอนเทนเนอร์และยืนยันว่าทำงานได้ตามที่ต้องการแล้ว คุณจะเผยแพร่คอนเทนเนอร์ได้ ค่าการกำหนดค่าคอนเทนเนอร์ แท็ก และเหตุการณ์จะแสดงต่อผู้ใช้ในครั้งถัดไปที่รีเฟรชคอนเทนเนอร์ ดูข้อมูลเพิ่มเติมเกี่ยวกับการรีเฟรชคอนเทนเนอร์

การกำหนดค่าขั้นสูง

ส่วนต่อไปนี้จะอธิบายตัวเลือกการกำหนดค่าขั้นสูงที่คุณต้องการใช้เพื่อปรับแต่งการติดตั้งใช้งาน Google Tag Manager เพิ่มเติม

การรีเฟรชคอนเทนเนอร์

โดยค่าเริ่มต้น คอนเทนเนอร์จะมีสิทธิ์รีเฟรชทุก 12 ชั่วโมง หากต้องการรีเฟรชคอนเทนเนอร์ด้วยตนเอง ให้ใช้ ContainerHolder.refresh():

ContainerHolderSingleton.getContainerHolder().refresh();

ซึ่งเป็นการเรียกแบบอะซิงโครนัสที่จะไม่แสดงผลทันที เพื่อลดการจราจรของข้อมูลในเครือข่าย ระบบอาจเรียกใช้ refresh() เพียงครั้งเดียวทุกๆ 15 นาที ไม่เช่นนั้นจะไม่มีการดำเนินการใดๆ