Başlama

Google Kullanıcı Mesajlaşma Platformu (UMP) SDK'sı, gizlilik tercihlerini yönetmenize yardımcı olan bir gizlilik ve mesajlaşma aracıdır. Daha fazla bilgi için Gizlilik ve Mesajlaşma hakkında başlıklı makaleyi inceleyin. UMP örnek uygulamalarında (Objective-C veya Swift) UMP SDK ile çalışan bir IMA uygulamasını görebilirsiniz.

Mesaj türü oluşturma

Ad Manager hesabınızın Gizlilik ve Mesajlaşma sekmesindeki Kullanılabilir kullanıcı mesajı türlerinden birini kullanarak kullanıcı mesajları oluşturun. UMP SDK, projenizde ayarlanan Interactive Media Ads uygulama kimliğinden oluşturulan bir gizlilik mesajı göstermeye çalışır.

Daha fazla bilgi için Gizlilik ve mesajlaşma hakkında başlıklı makaleyi inceleyin.

SDK'yı içe aktarma

UMP SDK, IMA SDK'nın bağımlılığı olarak dahil edilmez. Bu nedenle, UMP SDK'yı kendiniz açıkça eklemeniz gerekir.

CocoaPods (tercih edilen)

SDK'yı bir iOS projesine aktarmanın en kolay yolu CocoaPods'u kullanmaktır. Projenizin Podfile dosyasını açın ve bu satırı uygulamanızın hedefine ekleyin:

pod 'GoogleUserMessagingPlatform'

Ardından, aşağıdaki komutu çalıştırın:

pod install --repo-update

CocoaPods'u ilk kez kullanıyorsanız Podfile'ları oluşturma ve kullanma hakkında ayrıntılı bilgi için CocoaPods'u Kullanma başlıklı makaleyi inceleyin.

Swift Package Manager

UMP SDK, Swift Package Manager'ı da destekler. Swift paketini içe aktarmak için aşağıdaki adımları uygulayın.

1. Xcode'da File > Add Packages... (Dosya > Paket Ekle...) seçeneğine giderek UMP SDK Swift paketini yükleyin.

2. Görünen istemde UMP SDK Swift Package GitHub deposunu arayın:

   https://github.com/googleads/swift-package-manager-google-user-messaging-platform.git
   

3. Kullanmak istediğiniz UMP SDK Swift Paketi sürümünü seçin. Yeni projeler için Bir Sonraki Ana Sürüme Kadar'ı kullanmanızı öneririz.

Ardından Xcode, paket bağımlılıklarınızı çözümler ve bunları arka planda indirir. Paket bağımlılıklarını ekleme hakkında daha fazla bilgi için Apple'ın makalesine bakın.

Uygulama kimliğini ekleme

Uygulama kimliğinizi Ad Manager kullanıcı arayüzünde bulabilirsiniz. Aşağıdaki kod snippet'iyle kimliği Info.plist ekleyin:

<key>UMPApplicationIdentifier</key>
<string>ca-app-pub-xxxxxxxxxxxxxxxx~yyyyyyyyyy</string>

Kullanıcının izin bilgilerini alma

requestConsentInfoUpdateWithParameters:completionHandler: kullanarak her uygulama başlatıldığında kullanıcının izin bilgilerinin güncellenmesini istemelisiniz. Bu istekte aşağıdakiler kontrol edilir:

• İzin gerekip gerekmediği. Örneğin, ilk kez izin isteniyordur veya önceki izin kararı geçerliliğini yitirmiştir.
• Gizlilik seçenekleri giriş noktasının gerekli olup olmadığı. Bazı gizlilik mesajları, uygulamaların kullanıcıların gizlilik seçeneklerini istedikleri zaman değiştirmelerine izin vermesini gerektirir.

Swift

// Requesting an update to consent information should be called on every app launch.
ConsentInformation.shared.requestConsentInfoUpdate(with: parameters) {
  requestConsentError in
  // ...
}
ConsentManager.swift

Objective-C

// Requesting an update to consent information should be called on every app launch.
[UMPConsentInformation.sharedInstance
    requestConsentInfoUpdateWithParameters:parameters
                         completionHandler:^(NSError *_Nullable requestConsentError) {
                           // ...
                         }];
ConsentManager.m

Uyarı: İzin durumunu kontrol etmek için uygulamanızdaki önbellek veya daha önce kaydedilmiş bir izin dizesi gibi başka yöntemler kullanmak, izin süresi dolmuşsa TCF 3.3 hatasına yol açabilir.

Gizlilik mesajı formunu yükleyip sunma

En güncel izin durumunu aldıktan sonra kullanıcı izni almak için gereken formları yüklemek üzere loadAndPresentIfRequiredFromViewController:completionHandler: işlevini çağırın. Yüklendikten sonra formlar hemen gösterilir.

Önemli Nokta: Hiçbir gizlilik mesajı formu, reklam isteğinde bulunmadan önce kullanıcı rızasının alınmasını gerektirmiyorsa geri çağırma işlemi hemen başlatılır.

Swift

try await ConsentForm.loadAndPresentIfRequired(from: viewController)
ConsentManager.swift

Objective-C

[UMPConsentForm
    loadAndPresentIfRequiredFromViewController:viewController
                             completionHandler:^(NSError *_Nullable loadAndPresentError) {
                                 // Consent gathering process is complete.
                                }];
ConsentManager.m

Gizlilik seçenekleri

Bazı gizlilik mesajı formları, yayıncı tarafından oluşturulan bir gizlilik seçenekleri giriş noktasından sunulur. Bu sayede kullanıcılar, gizlilik seçeneklerini istedikleri zaman yönetebilir. Kullanıcılarınızın gizlilik seçenekleri giriş noktasında hangi mesajı gördüğü hakkında daha fazla bilgi edinmek için Mevcut kullanıcı mesajı türleri başlıklı makaleyi inceleyin.

Gizlilik seçenekleri giriş noktasının gerekli olup olmadığını kontrol etme

requestConsentInfoUpdateWithParameters:completionHandler: işlevini çağırdıktan sonra UMPConsentInformation.sharedInstance.privacyOptionsRequirementStatus işlevini kontrol ederek uygulamanız için gizlilik seçenekleri giriş noktası gerekip gerekmediğini belirleyin. Giriş noktası gerekiyorsa gizlilik seçenekleri formunu sunan görünür ve etkileşimli bir kullanıcı arayüzü öğesini uygulamanıza ekleyin. Gizlilik giriş noktası gerekmiyorsa kullanıcı arayüzü öğenizi görünür ve etkileşimli olmayacak şekilde yapılandırın.

Swift

var isPrivacyOptionsRequired: Bool {
  return ConsentInformation.shared.privacyOptionsRequirementStatus == .required
}
ConsentManager.swift

Objective-C

- (BOOL)isPrivacyOptionsRequired {
  return UMPConsentInformation.sharedInstance.privacyOptionsRequirementStatus ==
         UMPPrivacyOptionsRequirementStatusRequired;
}

- (void)gatherConsentFromConsentPresentationViewController:(UIViewController *)viewController
                                  consentGatheringComplete:
                                      (void (^)(NSError *_Nullable))consentGatheringComplete {
  UMPRequestParameters *parameters = [[UMPRequestParameters alloc] init];
  // Set tag for under age of consent. Use NO constant to indicate that the user is not under age.
  parameters.tagForUnderAgeOfConsent = NO;

  UMPDebugSettings *debugSettings = [[UMPDebugSettings alloc] init];
  // Uncomment the following line to simulate a consent request from users in the
  // European Economic Area (EEA) for testing purposes.
  // debugSettings.geography = UMPDebugGeographyEEA;
  parameters.debugSettings = debugSettings;

  // Requesting an update to consent information should be called on every app launch.
  [UMPConsentInformation.sharedInstance
      requestConsentInfoUpdateWithParameters:parameters
                           completionHandler:^(NSError *_Nullable requestConsentError) {
                             // ...
                           }];
}

- (void)loadAndPresentIfRequiredFromViewController:(UIViewController *)viewController
                           completionHandler:(void (^)(NSError *_Nullable))completionHandler {
  [UMPConsentForm
      loadAndPresentIfRequiredFromViewController:viewController
                               completionHandler:^(NSError *_Nullable loadAndPresentError) {
                                   // Consent gathering process is complete.
                                  }];
}

- (void)presentPrivacyOptionsFormFromViewController:(UIViewController *)viewController
                                  completionHandler:
                                      (void (^)(NSError *_Nullable))completionHandler {
  [UMPConsentForm presentPrivacyOptionsFormFromViewController:viewController
                                            completionHandler:completionHandler];
}

@end
ConsentManager.m

Gizlilik seçenekleri şart durumlarının tam listesi için UMPPrivacyOptionsRequirementStatus bölümüne bakın.

Gizlilik seçenekleri formunu sunma

Kullanıcı öğenizle etkileşimde bulunduğunda gizlilik seçenekleri formunu gösterin:

Swift

ConsentForm.presentPrivacyOptionsForm(
  from: viewController, completionHandler: completionHandler)
ConsentManager.swift

Objective-C

[UMPConsentForm presentPrivacyOptionsFormFromViewController:viewController
                                          completionHandler:completionHandler];
ConsentManager.m

Kullanıcı izniyle reklam isteğinde bulunma

Reklam istemeden önce, kullanıcıdan izin alıp almadığınızı kontrol etmek için UMPConsentInformation.sharedInstance.canRequestAds kullanın:

Swift

ConsentInformation.shared.canRequestAds

Objective-C

UMPConsentInformation.sharedInstance.canRequestAds;

İzin toplarken reklam isteğinde bulunup bulunamayacağınızı kontrol etmek için aşağıdaki yerlere bakabilirsiniz:

• UMP SDK, mevcut oturumda kullanıcı rızasını topladıktan sonra.
• requestConsentInfoUpdateWithParameters:completionHandler:'ı aradıktan hemen sonra UMP SDK, önceki uygulama oturumunda izin almış olabilir.

Önemli: UMPConsentInformation.sharedInstance.canRequestAds, requestConsentInfoUpdateWithParameters:completionHandler:'ü arayana kadar her zaman false değerini döndürür. requestConsentInfoUpdateWithParameters:completionHandler:

İzin toplama işlemi sırasında bir hata oluşursa reklam isteğinde bulunup bulunamayacağınızı kontrol edin. UMP SDK, önceki uygulama oturumundaki izin durumunu kullanır.

Gereksiz reklam isteği işlemlerini önleme

Kullanıcı rızasını aldıktan ve requestConsentInfoUpdateWithParameters:completionHandler: işlevini çağırdıktan sonra UMPConsentInformation.sharedInstance.canRequestAds işlevini kontrol ederken mantığınızın, her iki kontrolün de true döndürmesine neden olabilecek gereksiz reklam isteklerini engellediğinden emin olun. Örneğin, bir boolean değişkeniyle.

Test

Geliştirme sürecinde entegrasyonu uygulamanızda test etmek istiyorsanız test cihazınızı programatik olarak kaydetmek için bu adımları uygulayın. Uygulamanızı yayınlamadan önce bu test cihazı kimliklerini ayarlayan kodu kaldırdığınızdan emin olun.

Not: Simülatörler varsayılan olarak test cihazı olduklarından cihaz kimliği listenize eklenmeleri gerekmez.

1. requestConsentInfoUpdateWithParameters:completionHandler: Hizmetleri İçin Arayın.

2. Günlük çıktısında, cihaz kimliğinizi ve bunu nasıl test cihazı olarak ekleyeceğinizi gösteren aşağıdaki örneğe benzer bir mesaj olup olmadığını kontrol edin:

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

3. Test cihazı kimliğinizi panoya kopyalayın.

4. Kodunuzu, UMPDebugSettings().testDeviceIdentifiers işlevini çağıracak ve test cihazı kimliklerinizin listesini iletecek şekilde değiştirin.

   Swift

   let parameters = RequestParameters()
   let debugSettings = DebugSettings()
   
   debugSettings.testDeviceIdentifiers = ["TEST-DEVICE-HASHED-ID"]
   parameters.debugSettings = debugSettings
   
   // Include the UMPRequestParameters in your consent request.
   ConsentInformation.shared.requestConsentInfoUpdate(
       with: parameters,
       completionHandler: { error in
         // ...
       })
   

   Objective-C

   UMPRequestParameters *parameters = [[UMPRequestParameters alloc] init];
   UMPDebugSettings *debugSettings = [[UMPDebugSettings alloc] init];
   
   debugSettings.testDeviceIdentifiers = @[ @"TEST-DEVICE-HASHED-ID" ];
   parameters.debugSettings = debugSettings;
   
   // Include the UMPRequestParameters in your consent request.
   [UMPConsentInformation.sharedInstance
       requestConsentInfoUpdateWithParameters:parameters
                           completionHandler:^(NSError *_Nullable error){
                             // ...
   }];
   

Coğrafya zorlama

UMP SDK, UMPDebugGeography kullanarak uygulamanızın davranışını cihaz AEA veya Birleşik Krallık gibi çeşitli bölgelerdeymiş gibi test etmenizi sağlar. UMPDebugGeography Hata ayıklama ayarlarının yalnızca test cihazlarında çalıştığını unutmayın.

Swift

let parameters = RequestParameters()
let debugSettings = DebugSettings()

debugSettings.testDeviceIdentifiers = ["TEST-DEVICE-HASHED-ID"]
debugSettings.geography = .EEA
parameters.debugSettings = debugSettings

// Include the UMPRequestParameters in your consent request.
ConsentInformation.shared.requestConsentInfoUpdate(
    with: parameters,
    completionHandler: { error in
      // ...
    })

Objective-C

UMPRequestParameters *parameters = [[UMPRequestParameters alloc] init];
UMPDebugSettings *debugSettings = [[UMPDebugSettings alloc] init];

debugSettings.testDeviceIdentifiers = @[ @"TEST-DEVICE-HASHED-ID" ];
debugSettings.geography = UMPDebugGeographyEEA;
parameters.debugSettings = debugSettings;

// Include the UMPRequestParameters in your consent request.
[UMPConsentInformation.sharedInstance
    requestConsentInfoUpdateWithParameters:parameters
                         completionHandler:^(NSError *_Nullable error){
                           // ...
}];

İzin durumunu sıfırlama

Uygulamanızı UMP SDK ile test ederken, kullanıcının ilk yükleme deneyimini simüle edebilmek için SDK'nın durumunu sıfırlamanız faydalı olabilir. SDK, bunu yapmak için reset yöntemini sağlar.

Swift

ConsentInformation.shared.reset()

Objective-C

[UMPConsentInformation.sharedInstance reset];

Dikkat: Bu yöntem yalnızca test amacıyla kullanılmalıdır. Üretim kodunda reset işlevini çağırmamalısınız.

GitHub'daki örnekler

Bu sayfada ele alınan UMP SDK entegrasyonunun tam örneğini Swift UmpExample ve Objective-C UmpExample'de bulabilirsiniz.