শুরু করুন

Google User Messaging Platform (UMP) SDK হল একটি গোপনীয়তা ও মেসেজিং টুল যা আপনাকে গোপনীয়তা সংক্রান্ত পছন্দ ম্যানেজ করতে সাহায্য করে। আরও তথ্যের জন্য, গোপনীয়তা ও মেসেজিং সম্পর্কে দেখুন।

পূর্বশর্ত

  • Android API লেভেল 21 বা তার পরের যেকোনও ভার্সন (Android-এর জন্য)

মেসেজের ধরন তৈরি করা

আপনার AdMob অ্যাকাউন্টের গোপনীয়তা ও মেসেজিং ট্যাবে গিয়ে উপলভ্য ব্যবহারকারীর মেসেজের ধরন বিকল্পের মধ্যে একটি বেছে নিয়ে ব্যবহারকারীর মেসেজ তৈরি করুন। আপনার প্রোজেক্টে সেট করা AdMob অ্যাপ্লিকেশন আইডি থেকে তৈরি করা গোপনীয়তা মেসেজ UMP SDK দেখানোর চেষ্টা করে।

আরও বিবরণের জন্য, গোপনীয়তা ও মেসেজিং সম্পর্কে দেখুন।

SDK ইনস্টল করা

  1. Firebase C++ SDK ইনস্টল করতে ধাপগুলি অনুসরণ করুন। Firebase C++ SDK-তে UMP C++ SDK অন্তর্ভুক্ত থাকে।

  2. চালিয়ে যাওয়ার আগে, প্রজেক্টে আপনার অ্যাপের AdMob অ্যাপ আইডি কনফিগার করেছেন কিনা তা নিশ্চিত করুন।

  3. আপনার কোডে, UMP SDK-কে ConsentInfo::GetInstance() কল করে ইনিশিয়ালাইজ করুন।

    • Android-এ, আপনাকে NDK-এর দেওয়া JNIEnv ও Activity পাস করতে হবে। আপনি প্রথমবার GetInstance()-এ কল করলেই শুধু এটি করতে হবে।
    • অথবা, আপনি যদি আগে থেকেই নিজের অ্যাপে Firebase C++ SDK ব্যবহার করে থাকেন, তাহলে GetInstance() কল করার সময় প্রথমবার firebase::App পাস করতে পারবেন।
    #include "firebase/ump/ump.h"

namespace ump = ::firebase::ump;

// Initialize using a firebase::App
void InitializeUserMessagingPlatform(const firebase::App& app) {
  ump::ConsentInfo* consent_info = ump::ConsentInfo::GetInstance(app);
}

// Initialize without a firebase::App
#ifdef ANDROID
void InitializeUserMessagingPlatform(JNIEnv* jni_env, jobject activity) {
  ump::ConsentInfo* consent_info = ump::ConsentInfo::GetInstance(jni_env, activity);
}
#else  // non-Android
void InitializeUserMessagingPlatform() {
  ump::ConsentInfo* consent_info = ump::ConsentInfo::GetInstance();
}
#endif

ConsentInfo::GetInstance()-এ পরবর্তী কলগুলি একই ইনস্ট্যান্স রিটার্ন করে।

UMP SDK ব্যবহার করা হয়ে গেলে, আপনি ConsentInfo ইনস্ট্যান্স মুছে দিয়ে SDK বন্ধ করে দিতে পারেন:

void ShutdownUserMessagingPlatform() {
  ump::ConsentInfo* consent_info = ump::ConsentInfo::GetInstance();
  delete consent_info;
}

অ্যাসিঙ্ক্রোনাস অপারেশন মনিটর করতে Future ব্যবহার করুন

A firebase::Future আপনাকে অ্যাসিঙ্ক্রোনাস মেথড কলের সম্পূর্ণ হওয়ার স্ট্যাটাস নির্ধারণ করার একটি উপায় প্রদান করে।

অ্যাসিঙ্ক্রোনাস পদ্ধতিতে কাজ করে এমন সব UMP C++ ফাংশন ও মেথড কল একটি Future রিটার্ন করে এবং সবচেয়ে সাম্প্রতিক অপারেশন থেকে Future রিট্রিভ করার জন্য একটি "শেষ ফলাফল" ফাংশনও প্রদান করে।

Future থেকে ফলাফল পাওয়ার দুটি উপায় আছে:

  1. OnCompletion()-এ কল করুন, আপনার নিজস্ব কলব্যাক ফাংশন পাস করুন, যা অপারেশন সম্পূর্ণ হলে কল করা হয়।
  2. কিছু সময় অন্তর Future-এর status() চেক করুন। kFutureStatusPending থেকে kFutureStatusCompleted-এ স্ট্যাটাস পরিবর্তিত হলে, অপারেশন সম্পূর্ণ হয়েছে বলে ধরে নেওয়া হয়।

অ্যাসিঙ্ক্রোনাস অপারেশন সম্পূর্ণ হওয়ার পরে, আপনাকে Future-এর error() চেক করে অপারেশনের এরর কোড পেতে হবে। সমস্যার কোড 0 (kConsentRequestSuccess অথবা kConsentFormSuccess) হলে, অপারেশনটি সফলভাবে সম্পূর্ণ হয়েছে; অন্যথায়, সমস্যার কোড চেক করুন এবং error_message() কী ভুল হয়েছে তা নির্ধারণ করুন।

সম্পূর্ণ হওয়ার কলব্যাক

অ্যাসিঙ্ক্রোনাস অপারেশন সম্পূর্ণ হলে কল করা হয় এমন একটি কমপ্লিশন কলব্যাক সেট করতে, কীভাবে OnCompletion ব্যবহার করতে হয় তার একটি উদাহরণ এখানে দেওয়া হল।

void MyApplicationStart() {
  // [... other app initialization code ...]

  ump::ConsentInfo *consent_info = ump::ConsentInfo::GetInstance();

  // See the section below for more information about RequestConsentInfoUpdate.
  firebase::Future<void> result = consent_info->RequestConsentInfoUpdate(...);

  result.OnCompletion([](const firebase::Future<void>& req_result) {
    if (req_result.error() == ump::kConsentRequestSuccess) {
      // Operation succeeded. You can now call LoadAndShowConsentFormIfRequired().
    } else {
      // Operation failed. Check req_result.error_message() for more information.
    }
  });
}

লুপ পোলিং আপডেট করা

এই উদাহরণে, অ্যাপ লঞ্চে অ্যাসিঙ্ক্রোনাস অপারেশন শুরু হওয়ার পরে, ফলাফল গেমের আপডেট লুপ ফাংশনে (যা প্রতি ফ্রেমে একবার রান করে) অন্য কোথাও চেক করা হয়।

ump::ConsentInfo *g_consent_info = nullptr;
bool g_waiting_for_request = false;

void MyApplicationStart() {
  // [... other app initialization code ...]

  g_consent_info = ump::ConsentInfo::GetInstance();
  // See the section below for more information about RequestConsentInfoUpdate.
  g_consent_info->RequestConsentInfoUpdate(...);
  g_waiting_for_request = true;
}

// Elsewhere, in the game's update loop, which runs once per frame:
void MyGameUpdateLoop() {
  // [... other game logic here ...]

  if (g_waiting_for_request) {
    // Check whether RequestConsentInfoUpdate() has finished.
    // Calling "LastResult" returns the Future for the most recent operation.
    firebase::Future<void> result =
      g_consent_info->RequestConsentInfoUpdateLastResult();

    if (result.status() == firebase::kFutureStatusComplete) {
      g_waiting_for_request = false;
      if (result.error() == ump::kConsentRequestSuccess) {
        // Operation succeeded. You can call LoadAndShowConsentFormIfRequired().
      } else {
        // Operation failed. Check result.error_message() for more information.
      }
    }
  }
}

firebase::Future সম্পর্কে আরও জানতে, Firebase C++ SDK ডকুমেন্টেশন এবং GMA C++ SDK ডকুমেন্টেশন দেখুন।

RequestConsentInfoUpdate() ব্যবহার করে, প্রতিটি অ্যাপ লঞ্চে ব্যবহারকারীর সম্মতি সংক্রান্ত তথ্য আপডেট করার অনুরোধ করা উচিত। এই অনুরোধ নিম্নলিখিত বিষয়গুলি চেক করে:

  • সম্মতি প্রয়োজন কিনা। যেমন, প্রথমবার সম্মতি দেওয়ার জন্য অথবা আগের সম্মতি সংক্রান্ত সিদ্ধান্তের মেয়াদ শেষ হয়ে গেলে সম্মতি প্রয়োজন।
  • গোপনীয়তা বিকল্পের এন্ট্রি পয়েন্ট প্রয়োজন কিনা। কিছু গোপনীয়তা মেসেজে অ্যাপকে ব্যবহারকারীদের যেকোনও সময় গোপনীয়তা বিকল্প পরিবর্তন করার অনুমতি দিতে হয়।
#include "firebase/ump/ump.h"

namespace ump = ::firebase::ump;

void MyApplicationStart(ump::FormParent parent) {
  ump::ConsentInfo* consent_info = ump::ConsentInfo::GetInstance();

  // Create a ConsentRequestParameters struct..
  ump::ConsentRequestParameters params;
  // Set tag for under age of consent. False means users are NOT under age of consent.
  params.tag_for_under_age_of_consent = false;

  consent_info->RequestConsentInfoUpdate(params).OnCompletion(
    [*](const Future<void>& req_result) {
      if (req_result.error() != ump::kConsentRequestSuccess) {
        // req_result.error() is a kConsentRequestError enum.
        LogMessage("Error requesting consent update: %s", req_result.error_message());
      }
      // Consent information is successfully updated.
    });
}

গোপনীয়তা মেসেজ ফর্ম লোড ও উপস্থাপন করা

আপনি সবচেয়ে আপ-টু-ডেট সম্মতি স্ট্যাটাস পাওয়ার পরে, ব্যবহারকারীর সম্মতি সংগ্রহ করার জন্য প্রয়োজনীয় যেকোনও ফর্ম লোড করতে LoadAndShowConsentFormIfRequired() কল করুন। লোড করার পরে, ফর্মটি সাথে সাথেই দেখা যায়।

#include "firebase/ump/ump.h"

namespace ump = ::firebase::ump;

void MyApplicationStart(ump::FormParent parent) {
  ump::ConsentInfo* consent_info = ump::ConsentInfo::GetInstance();

  // Create a ConsentRequestParameters struct..
  ump::ConsentRequestParameters params;
  // Set tag for under age of consent. False means users are NOT under age of consent.
  params.tag_for_under_age_of_consent = false;

  consent_info->RequestConsentInfoUpdate(params).OnCompletion(
    [*](const Future<void>& req_result) {
      if (req_result.error() != ump::kConsentRequestSuccess) {
        // req_result.error() is a kConsentRequestError enum.
        LogMessage("Error requesting consent update: %s", req_result.error_message());
      } else {
        consent_info->LoadAndShowConsentFormIfRequired(parent).OnCompletion(
        [*](const Future<void>& form_result) {
          if (form_result.error() != ump::kConsentFormSuccess) {
            // form_result.error() is a kConsentFormError enum.
            LogMessage("Error showing privacy message form: %s", form_result.error_message());
          } else {
            // Either the form was shown and completed by the user, or consent was not required.
          }
        });
      }
    });
}

সম্পূর্ণতা চেক করার জন্য, সম্পূর্ণতা কলব্যাক ব্যবহার না করে আপডেট লুপ পোলিং ব্যবহার করার একটি উদাহরণ উপরে দেখুন।

ব্যবহারকারী কোনও বিকল্প বেছে নিলে বা ফর্মটি বাতিল করে দিলে আপনাকে যদি কোনও অ্যাকশন নিতে হয়, তাহলে Future LoadAndShowConsentFormIfRequired()-এর মাধ্যমে রিটার্ন করা কোডে সেই লজিকটি রাখুন।

গোপনীয়তা সংক্রান্ত বিকল্প

প্রকাশকের রেন্ডার করা গোপনীয়তা বিকল্প এন্ট্রি পয়েন্ট থেকে গোপনীয়তা মেসেজের কিছু ফর্ম দেখানো হয়, এর ফলে ব্যবহারকারীরা যেকোনও সময় তাদের গোপনীয়তা বিকল্প ম্যানেজ করতে পারেন। গোপনীয়তা বিকল্পের এন্ট্রি পয়েন্টে আপনার ব্যবহারকারীরা কোন মেসেজ দেখতে পাবেন সেই সম্পর্কে আরও জানতে, উপলভ্য ব্যবহারকারীর মেসেজের ধরন দেখুন।

ব্যবহারকারীর সম্মতি সহ বিজ্ঞাপন অনুরোধ করা

বিজ্ঞাপনের অনুরোধ করার আগে, আপনি ব্যবহারকারীর থেকে সম্মতি পেয়েছেন কিনা তা চেক করতে ConsentInfo::GetInstance()‑> CanRequestAds() ব্যবহার করুন:

সম্মতি সংগ্রহ করার সময় আপনি বিজ্ঞাপন অনুরোধ করতে পারবেন কিনা তা চেক করার জন্য নিচে উল্লেখ করা জায়গাগুলি দেখুন:

  • বর্তমান সেশনে UMP SDK সম্মতি সংগ্রহ করার পরে।
  • RequestConsentInfoUpdate()-এ কল করার সাথে সাথেই। UMP SDK হয়ত আগের অ্যাপ সেশনে সম্মতি পেয়েছে।

সম্মতি সংগ্রহ করার প্রসেস চলাকালীন কোনও সমস্যা হলে, আপনি বিজ্ঞাপন দেখানোর অনুরোধ করতে পারবেন কিনা তা চেক করুন। UMP SDK আগের অ্যাপ সেশন থেকে সম্মতি সংক্রান্ত স্ট্যাটাস ব্যবহার করে।

বিজ্ঞাপনের অনুরোধ সংক্রান্ত অপ্রয়োজনীয় কাজ এড়ানো

সম্মতি সংগ্রহ করার পরে এবং RequestConsentInfoUpdate() কল করার পরে আপনি ConsentInfo::GetInstance()‑> CanRequestAds() চেক করার সময়, আপনার লজিক যেন অপ্রয়োজনীয় বিজ্ঞাপনের অনুরোধ আটকায় তা নিশ্চিত করুন, কারণ এর ফলে দুটি চেক থেকেই true রিটার্ন হতে পারে। যেমন, কোনও বুলিয়ান ভেরিয়েবলের সাথে।

নিচে দেওয়া সম্পূর্ণ উদাহরণে আপডেট লুপ পোলিং ব্যবহার করা হয়েছে, তবে অ্যাসিঙ্ক্রোনাস অপারেশন মনিটর করার জন্য আপনি এছাড়াও OnCompletion কলব্যাক ব্যবহার করতে পারেন। আপনার কোড স্ট্রাকচারের সাথে যে টেকনিকটি বেশি মানানসই, সেটি ব্যবহার করুন।

#include "firebase/future.h"
#include "firebase/gma/gma.h"
#include "firebase/ump/ump.h"

namespace gma = ::firebase::gma;
namespace ump = ::firebase::ump;
using firebase::Future;

ump::ConsentInfo* g_consent_info = nullptr;
// State variable for tracking the UMP consent flow.
enum { kStart, kRequest, kLoadAndShow, kInitGma, kFinished, kErrorState } g_state = kStart;
bool g_ads_allowed = false;

void MyApplicationStart() {
  g_consent_info = ump::ConsentInfo::GetInstance(...);

  // Create a ConsentRequestParameters struct..
  ump::ConsentRequestParameters params;
  // Set tag for under age of consent. False means users are NOT under age of consent.
  params.tag_for_under_age_of_consent = false;

  g_consent_info->RequestConsentInfoUpdate(params);
  // CanRequestAds() can return a cached value from a previous run immediately.
  g_ads_allowed = g_consent_info->CanRequestAds();
  g_state = kRequest;
}

// This function runs once per frame.
void MyGameUpdateLoop() {
  // [... other game logic here ...]

  if (g_state == kRequest) {
    Future<void> req_result = g_consent_info->RequestConsentInfoUpdateLastResult();

    if (req_result.status() == firebase::kFutureStatusComplete) {
      g_ads_allowed = g_consent_info->CanRequestAds();
      if (req_result.error() == ump::kConsentRequestSuccess) {
        // You must provide the FormParent (Android Activity or iOS UIViewController).
        ump::FormParent parent = GetMyFormParent();
        g_consent_info->LoadAndShowConsentFormIfRequired(parent);
        g_state = kLoadAndShow;
      } else {
        LogMessage("Error requesting consent status: %s", req_result.error_message());
        g_state = kErrorState;
      }
    }
  }
  if (g_state == kLoadAndShow) {
    Future<void> form_result = g_consent_info->LoadAndShowConsentFormIfRequiredLastResult();

    if (form_result.status() == firebase::kFutureStatusComplete) {
      g_ads_allowed = g_consent_info->CanRequestAds();
      if (form_result.error() == ump::kConsentRequestSuccess) {
        if (g_ads_allowed) {
          // Initialize GMA. This is another asynchronous operation.
          firebase::gma::Initialize();
          g_state = kInitGma;
        } else {
          g_state = kFinished;
        }
        // Optional: shut down the UMP SDK to save memory.
        delete g_consent_info;
        g_consent_info = nullptr;
      } else {
        LogMessage("Error displaying privacy message form: %s", form_result.error_message());
        g_state = kErrorState;
      }
    }
  }
  if (g_state == kInitGma && g_ads_allowed) {
    Future<gma::AdapterInitializationStatus> gma_future = gma::InitializeLastResult();

    if (gma_future.status() == firebase::kFutureStatusComplete) {
      if (gma_future.error() == gma::kAdErrorCodeNone) {
        g_state = kFinished;
        // TODO: Request an ad.
      } else {
        LogMessage("Error initializing GMA: %s", gma_future.error_message());
        g_state = kErrorState;
      }
    }
  }
}

পরীক্ষা করা

আপনি ডেভেলপ করার সময় নিজের অ্যাপে ইন্টিগ্রেশন পরীক্ষা করতে চাইলে, আপনার টেস্ট ডিভাইস প্রোগ্রাম্যাটিক উপায়ে রেজিস্টার করতে এইসব ধাপ অনুসরণ করুন। আপনার অ্যাপ রিলিজ করার আগে, এইসব টেস্ট ডিভাইস আইডি সেট করা কোডটি সরিয়ে দিতে ভুলবেন না।

  1. RequestConsentInfoUpdate()-এ কল করুন।

  2. নিচের উদাহরণের মতো মেসেজের জন্য লগ আউটপুট চেক করুন, যা আপনার ডিভাইস আইডি এবং কীভাবে এটি একটি টেস্ট ডিভাইস হিসেবে যোগ করতে হয় তা দেখায়:

    Android

    Use new ConsentDebugSettings.Builder().addTestDeviceHashedId("33BE2250B43518CCDA7DE426D04EE231")
to set this as a debug device.

    iOS

    <UMP SDK>To enable debug mode for this device,
set: UMPDebugSettings.testDeviceIdentifiers = @[2077ef9a63d2b398840261c8221a0c9b]

  3. আপনার ক্লিপবোর্ডে টেস্ট ডিভাইসের আইডি কপি করুন।

  4. আপনার কোড পরিবর্তন করে সেট ConsentRequestParameters.debug_settings.debug_device_ids-কে আপনার টেস্ট ডিভাইস আইডির একটি তালিকায় পরিবর্তন করুন।

    void MyApplicationStart() {
  ump::ConsentInfo consent_info = ump::ConsentInfo::GetInstance(...);

  ump::ConsentRequestParameters params;
  params.tag_for_under_age_of_consent = false;
  params.debug_settings.debug_device_ids = {"TEST-DEVICE-HASHED-ID"};

  consent_info->RequestConsentInfoUpdate(params);
}

ভৌগোলিক অবস্থান ফোর্স করা

UMP SDK এমন একটি উপায় প্রদান করে যার মাধ্যমে আপনার অ্যাপের আচরণ পরীক্ষা করা যায়, যেন ডিভাইসটি ইউরোপীয় অর্থনৈতিক অঞ্চল (EEA), যুক্তরাজ্য (UK) এবং সুইজারল্যান্ডের মতো বিভিন্ন অঞ্চলে অবস্থিত। এটি debug_settings.debug_geography ব্যবহার করে করা হয়। মনে রাখবেন যে ডিবাগ সেটিংস শুধুমাত্র টেস্ট ডিভাইসে কাজ করে।

void MyApplicationStart() {
  ump::ConsentInfo consent_info = ump::ConsentInfo::GetInstance(...);

  ump::ConsentRequestParameters params;
  params.tag_for_under_age_of_consent = false;
  params.debug_settings.debug_device_ids = {"TEST-DEVICE-HASHED-ID"};
  // Geography appears as EEA for debug devices.
  params.debug_settings.debug_geography = ump::kConsentDebugGeographyEEA

  consent_info->RequestConsentInfoUpdate(params);
}

UMP SDK-এর মাধ্যমে আপনার অ্যাপ পরীক্ষা করার সময়, SDK-এর স্টেট রিসেট করলে আপনার সুবিধা হতে পারে, যাতে আপনি কোনও ব্যবহারকারীর প্রথমবার ইনস্টল করার অভিজ্ঞতা সিমুলেট করতে পারেন। এটি করার জন্য SDK Reset() পদ্ধতি প্রদান করে।

  ConsentInfo::GetInstance()->Reset();