این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

راه‌اندازی UMP SDK، راه‌اندازی UMP SDK

انتخاب پلتفرم: اندروید

کیت توسعه نرم‌افزار (SDK) پلتفرم پیام‌رسانی کاربر گوگل (UMP) ابزاری برای حفظ حریم خصوصی و پیام‌رسانی است که به شما در مدیریت گزینه‌های حریم خصوصی کمک می‌کند. برای اطلاعات بیشتر، به «درباره حریم خصوصی و پیام‌رسانی» مراجعه کنید.

ایجاد نوع پیام

پیام‌های کاربری را با یکی از انواع پیام‌های کاربری موجود در زیر برگه حریم خصوصی و پیام‌رسانی حساب AdMob خود ایجاد کنید. UMP SDK تلاش می‌کند تا یک پیام حریم خصوصی ایجاد شده از شناسه برنامه AdMob تنظیم شده در پروژه شما را نمایش دهد.

برای جزئیات بیشتر، به «درباره حریم خصوصی و پیام‌رسانی» مراجعه کنید.

SDK را وارد کنید

پودر کاکائو (ترجیحاً)

ساده‌ترین راه برای وارد کردن SDK به یک پروژه iOS استفاده از CocoaPods است. Podfile پروژه خود را باز کنید و این خط را به target برنامه خود اضافه کنید:

pod 'GoogleUserMessagingPlatform'

سپس، دستور زیر را اجرا کنید:

pod install --repo-update

اگر در CocoaPods تازه‌کار هستید، برای جزئیات بیشتر در مورد نحوه ایجاد و استفاده از Podfiles به بخش «استفاده از CocoaPods» مراجعه کنید.

مدیر بسته سوئیفت

UMP SDK همچنین از Swift Package Manager پشتیبانی می‌کند. برای وارد کردن بسته Swift، این مراحل را دنبال کنید.

در Xcode، با رفتن به مسیر File > Add Packages...، بسته‌ی سویفت UMP SDK را نصب کنید.
در اعلانی که ظاهر می‌شود، مخزن گیت‌هاب UMP SDK Swift Package را جستجو کنید:
```
https://github.com/googleads/swift-package-manager-google-user-messaging-platform.git
```
نسخه UMP SDK Swift Package مورد نظر خود را انتخاب کنید. برای پروژه‌های جدید، توصیه می‌کنیم از Up to Next Major Version استفاده کنید.

سپس Xcode وابستگی‌های بسته شما را حل کرده و آنها را در پس‌زمینه دانلود می‌کند. برای جزئیات بیشتر در مورد نحوه اضافه کردن وابستگی‌های بسته، به مقاله اپل مراجعه کنید.

دانلود دستی

راه دیگر برای وارد کردن SDK، انجام آن به صورت دستی است.

دانلود SDK

سپس، فریم‌ورک را به پروژه Xcode خود بکشید و در صورت نیاز، مطمئن شوید که گزینه Copy items را انتخاب کرده‌اید.

سپس می‌توانید با استفاده از دستور زیر، چارچوب را در هر فایلی که نیاز دارید، وارد کنید:

سویفت

import UserMessagingPlatform

هدف-سی

#include <UserMessagingPlatform/UserMessagingPlatform.h>

شناسه برنامه را اضافه کنید

می‌توانید شناسه برنامه خود را در رابط کاربری AdMob پیدا کنید. شناسه را با استفاده از قطعه کد زیر به Info.plist خود اضافه کنید:

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

دریافت اطلاعات رضایت کاربر

شما باید در هر بار اجرای برنامه، با استفاده requestConsentInfoUpdate(with:completionHandler:) درخواست به‌روزرسانی اطلاعات رضایت کاربر را بدهید. این درخواست موارد زیر را بررسی می‌کند:

آیا رضایت لازم است ؟ برای مثال، آیا برای اولین بار رضایت لازم است یا تصمیم رضایت قبلی منقضی شده است.
اینکه آیا به نقطه ورود گزینه‌های حریم خصوصی نیاز است یا خیر . برخی از پیام‌های حریم خصوصی از برنامه‌ها می‌خواهند که به کاربران اجازه دهند گزینه‌های حریم خصوصی خود را در هر زمانی تغییر دهند.

سویفت


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

سویفت‌یو‌آی


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

هدف-سی


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

فرم پیام حریم خصوصی را بارگیری و ارائه دهید

After you have received the most up-to-date consent status, call loadAndPresentIfRequired(from:) to load any forms required to collect user consent. After loading, the forms present immediately.

سویفت


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

سویفت‌یو‌آی


try await ConsentForm.loadAndPresentIfRequired(from: nil)GoogleMobileAdsConsentManager.swift

هدف-سی


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

گزینه‌های حریم خصوصی

برخی از فرم‌های پیام‌های حریم خصوصی از یک نقطه ورود گزینه‌های حریم خصوصی ارائه شده توسط ناشر ارائه می‌شوند و به کاربران اجازه می‌دهند گزینه‌های حریم خصوصی خود را در هر زمانی مدیریت کنند. برای کسب اطلاعات بیشتر در مورد اینکه کاربران شما در نقطه ورود گزینه‌های حریم خصوصی چه پیامی را می‌بینند، به انواع پیام‌های موجود برای کاربر مراجعه کنید.

بررسی کنید که آیا به نقطه ورود گزینه‌های حریم خصوصی نیاز است یا خیر

پس از فراخوانی requestConsentInfoUpdate(with:completionHandler:) ، وضعیت UMPConsentInformation.sharedInstance.privacyOptionsRequirementStatus را بررسی کنید تا مشخص شود که آیا نقطه ورود گزینه‌های حریم خصوصی برای برنامه شما مورد نیاز است یا خیر. اگر نقطه ورود مورد نیاز است، یک عنصر رابط کاربری قابل مشاهده و تعاملی به برنامه خود اضافه کنید که فرم گزینه‌های حریم خصوصی را ارائه دهد. اگر نقطه ورود حریم خصوصی مورد نیاز نیست، عنصر رابط کاربری خود را طوری پیکربندی کنید که قابل مشاهده و تعاملی نباشد.

سویفت


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

هدف-سی


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

برای فهرست کامل وضعیت‌های الزامات گزینه‌های حریم خصوصی، به UMPPrivacyOptionsRequirementStatus مراجعه کنید.

فرم گزینه‌های حریم خصوصی را ارائه دهید

وقتی کاربر با عنصر شما تعامل می‌کند، فرم گزینه‌های حریم خصوصی را نمایش دهید:

سویفت


try await ConsentForm.presentPrivacyOptionsForm(from: viewController)GoogleMobileAdsConsentManager.swift

سویفت‌یو‌آی


try await ConsentForm.presentPrivacyOptionsForm(from: nil)GoogleMobileAdsConsentManager.swift

هدف-سی


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

درخواست تبلیغات با رضایت کاربر

قبل از درخواست تبلیغات، از UMPConsentInformation.sharedInstance.canRequestAds برای بررسی اینکه آیا رضایت کاربر را دریافت کرده‌اید یا خیر، استفاده کنید:

سویفت

ConsentInformation.shared.canRequestAds

هدف-سی

UMPConsentInformation.sharedInstance.canRequestAds;

مکان‌های زیر برای بررسی اینکه آیا می‌توانید ضمن جمع‌آوری رضایت، درخواست تبلیغات دهید، فهرست شده‌اند:

پس از اینکه UMP SDK در جلسه فعلی رضایت را جمع آوری کرد.
بلافاصله پس از اینکه requestConsentInfoUpdate(with:completionHandler:) را فراخوانی کردید. ممکن است UMP SDK در جلسه قبلی برنامه، رضایت را دریافت کرده باشد.

اگر در طول فرآیند جمع‌آوری رضایت خطایی رخ داد، بررسی کنید که آیا می‌توانید درخواست تبلیغات دهید یا خیر. UMP SDK از وضعیت رضایت جلسه قبلی برنامه استفاده می‌کند.

جلوگیری از کارهای تکراری درخواست تبلیغات

As you check UMPConsentInformation.sharedInstance.canRequestAds after gathering consent and after calling requestConsentInfoUpdate(with:completionHandler:) , ensure your logic prevents redundant ad requests that might result in both checks returning true . For example, with a boolean variable.

آزمایش

اگر می‌خواهید در حین توسعه، ادغام را در برنامه خود آزمایش کنید، این مراحل را برای ثبت برنامه‌ای دستگاه آزمایشی خود دنبال کنید. قبل از انتشار برنامه، حتماً کدی را که این شناسه‌های دستگاه آزمایشی را تنظیم می‌کند، حذف کنید.

فراخوانی requestConsentInfoUpdate(with:completionHandler:) .
خروجی گزارش را برای پیامی مشابه مثال زیر بررسی کنید، که شناسه دستگاه شما و نحوه اضافه کردن آن به عنوان یک دستگاه آزمایشی را نشان می‌دهد:
```
<UMP SDK>To enable debug mode for this device, set: UMPDebugSettings.testDeviceIdentifiers = @[2077ef9a63d2b398840261c8221a0c9b]
```
شناسه دستگاه آزمایشی خود را در کلیپ‌بورد کپی کنید.

کد خود را طوری تغییر دهید که UMPDebugSettings().testDeviceIdentifiers فراخوانی کند و لیستی از شناسه‌های دستگاه‌های آزمایشی شما را ارسال کند.

سویفت

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
      // ...
    })

هدف-سی

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){
                          // ...
}];

یک جغرافیا را تحمیل کنید

The UMP SDK provides a way to test your app's behavior as though the device were located in various regions, such as the European Economic Area (EEA), the United Kingdom (UK), and Switzerland using geography . Note that debug settings only work on test devices.

سویفت

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
      // ...
    })

هدف-سی

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){
                           // ...
}];

تنظیم مجدد وضعیت رضایت

When testing your app with the UMP SDK, you might find it helpful to reset the state of the SDK so that you can simulate a user's first install experience. The SDK provides the reset method to do this.

سویفت

ConsentInformation.shared.reset()

هدف-سی

[UMPConsentInformation.sharedInstance reset];

مثال‌ها در گیت‌هاب

یک مثال کامل از یکپارچه‌سازی UMP SDK که در این صفحه پوشش داده شده است را ببینید.

راه‌اندازی UMP SDK، راه‌اندازی UMP SDK با مجموعه‌ها، منظم بمانید ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.

ایجاد نوع پیام

SDK را وارد کنید

پودر کاکائو (ترجیحاً)

مدیر بسته سوئیفت

دانلود دستی

سویفت

هدف-سی

شناسه برنامه را اضافه کنید

دریافت اطلاعات رضایت کاربر

سویفت

سویفت‌یو‌آی

هدف-سی

فرم پیام حریم خصوصی را بارگیری و ارائه دهید

سویفت

سویفت‌یو‌آی

هدف-سی

گزینه‌های حریم خصوصی

بررسی کنید که آیا به نقطه ورود گزینه‌های حریم خصوصی نیاز است یا خیر

سویفت

هدف-سی

فرم گزینه‌های حریم خصوصی را ارائه دهید

سویفت

سویفت‌یو‌آی

هدف-سی

درخواست تبلیغات با رضایت کاربر

سویفت

هدف-سی

جلوگیری از کارهای تکراری درخواست تبلیغات

آزمایش

سویفت

هدف-سی

یک جغرافیا را تحمیل کنید

سویفت

هدف-سی

تنظیم مجدد وضعیت رضایت

سویفت

هدف-سی

مثال‌ها در گیت‌هاب

راه‌اندازی UMP SDK، راه‌اندازی UMP SDK