Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions prebid-mobile/pbm-api/android/pbm-targeting-android.md
Original file line number Diff line number Diff line change
Expand Up @@ -348,6 +348,23 @@ Parameters:
| --- | --- | --- | --- | --- |
| eventDelegate | required | PrebidEventDelegate | The callback for handling all requests and responses. This interface takes request and response as the JSONObject types. | `{ request, response -> ... }` |

#### setDisableStatusCheck()

Informs the SDK whether it should check the PBS status during initialization. This will save initialization time if the PBS endpoint is always live and handled client side.

Signature:

```java
public static void setDisableStatusCheck(boolean disableStatusCheck)
```

Parameters:

{: .table .table-bordered .table-striped }
| Parameter | Scope | Type | Description | Example |
| --- | --- | --- | --- | --- |
| disableStatusCheck | required | boolean | Indicates whether the SDK should opt out of the PBS status checking during initialization. Default is `false`. | `true` |

---

## Consent Management Parameters
Expand Down
38 changes: 13 additions & 25 deletions prebid-mobile/pbm-api/ios/code-integration-ios.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,36 +47,24 @@ If you are not familiar with the Carthage package builder, please refer to the p
2. Drag `PrebidMobile.xcframework` from `generated/output` directory into your project. Make sure "Copy items if needed" is selected.
3. Go to your Xcode project’s `General -> Frameworks, Libraries, and Embedded Content` settings. Use `Embed & Sign` for dynamic and `Do Not Embed` for static linking

### Swift PM
### Swift Package Manager (SPM)

SPM isn't supported for Prebid SDK `2.0.0` and higher ([details](https://github.com/prebid/prebid-mobile-ios/issues/640)).
Starting from version `3.1.0`, PrebidMobile supports the Swift Package Manager (SPM), making integration much easier and more maintainable compared to manual setups or CocoaPods.

The next guide is applicable to `1.x` versions of the SDK.
To [add the Prebid Mobile SDK package dependency](https://developer.apple.com/documentation/xcode/adding-package-dependencies-to-your-app#Add-a-package-dependency) using SPM, follow these steps:

If you are not familiar with the Swift Package Manager, please refer to the project [github page](https://github.com/apple/swift-package-manager) for more details.
1. In Xcode, install the Prebid Mobile SDK by navigating to File > Add Package Dependencies...
2. In the prompt that appears, search for the Prebid Mobile SDK GitHub repository:

1. Add Prebid dependency `File -> Swift Packages -> Add Package Dependency...`
2. Select desired version, branch or commit
3. Select Prebid [module]({{site.baseurl}}/prebid-mobile/modules/modules-overview.html)
4. Build the specific schema `CarthageBuild.sh`
```bash
https://github.com/prebid/prebid-mobile-ios.git
```

3. Select the version of the Prebid Mobile SDK you want to use. For new projects, we recommend using the `Up to Next Major Version`.
4. In the package selection screen, make sure to check the modules you need for your integration and link it to your application target.

**Variant 1**

- Run CarthageBuild.sh script from Cartfile folder. The path should be:
`.../Carthage/Checkouts/prebid-mobile-ios/scripts/CarthageBuild.sh`
- Enter Schema name (PrebidMobile or PrebidMobileCore)
- If you run CarthageBuild.sh and see Permission denied use:
`chmod +x <path_to_CarthageBuild.sh>`

**Variant 2**

- Open `PrebidMobile.xcodeproj` at `.../Carthage/Checkouts/prebid-mobile-ios/PrebidMobile.xcodeproj` using Xcode
- Manage Schemes -> Check Shared checkbox for a necessary schema
- run `carthage build prebid-mobile-ios`

5. Integrate the binary into your project

You can find the schema name in the build PrebidSDK framework inside Info.plist with `PrebidMobileName` key
{: .alert.alert-info :}
The Swift Package Manager (SPM) integration is currently marked as beta. We are actively working on refining the project structure and modularization to improve clarity, performance, and ease of integration. During this period, some modules or dependencies may be reorganized. We welcome your feedback - if you encounter any issues or have suggestions, please don't hesitate to reach out and help us shape the future of the PrebidMobile SPM support.

### Build framework from source

Expand Down
1 change: 1 addition & 0 deletions prebid-mobile/pbm-api/ios/pbm-targeting-ios.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ Prebid.shared.customStatusEndpoint="https://pbs.example.com/v2/status"
| includeWinners | optional | boolean | ORTB | If `true`, Prebid sdk will add `includewinners` flag inside the targeting object described in [PBS Documentation](/prebid-server/endpoints/openrtb2/pbs-endpoint-auction.html#targeting) . Default is `false`. | `true` |
| includeBidderKeys | optional | boolean | ORTB | If `true`, Prebid sdk will add `includebidderkeys` flag inside the targeting object described in [PBS Documentation](/prebid-server/endpoints/openrtb2/pbs-endpoint-auction.html#targeting) . Default is `false`. | `true` |
| eventDelegate | optional | PrebidEventDelegate | init | Sets an event delegate to handle all auction requests and responses. It allows to collect some statistical data. Note that the SDK stores this callback as a weak reference so you need to store a reference to it. | `class PrebidEventDelegateTestsMockDelegate: PrebidEventDelegate { func prebidBidRequestDidFinish(requestData: Data?, responseData: Data?) { ... } }` |
| shouldDisableStatusCheck | optional | boolean | init | If `true`, the SDK will not check the PBS status during initialization. This will save initialization time if the PBS endpoint is always live and handled client side. Default is `false`. | `true` |

### Prebid Class Global Methods

Expand Down