Skip to content

Commit

Permalink
Merge pull request #700 from IABTechLab/gwh-APIDOCS-2558-01-mobile-do…
Browse files Browse the repository at this point in the history
…cs-minor-tweaks

minor UID2 mods from EUID mobile work
  • Loading branch information
genwhittTTD authored Sep 9, 2024
2 parents 2b52138 + 5f48417 commit 750fca3
Show file tree
Hide file tree
Showing 13 changed files with 12 additions and 12 deletions.
4 changes: 2 additions & 2 deletions docs/guides/google-ss-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,9 @@ The following sample applications are available to illustrate how to integrate w

Each sample application has its own instructions.

## Troubleshooting Tips for UID2 Integration with Google Secure Signals
## Troubleshooting

Here is some troubleshooting info that might help you in working with Google Secure Signals for your UID2 integration:
Here is some troubleshooting information that might help you in working with Google Secure Signals for your UID2 integration:

- [I enabled Secure Signals within Google Ad Manager, but UID2s are not being passed through Google](#i-enabled-secure-signals-within-google-ad-manager-but-uid2s-are-not-being-passed-through-google)

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/integration-aws-entity-resolution.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ To create the matching workflow, first sign in to the AWS Management console, op

## Run the Matching Workflow

Follow the steps below to run the matching workflow and view the results.
Follow these steps to run the matching workflow and view the results.

For details, see [Running and managing matching workflows](https://docs.aws.amazon.com/entityresolution/latest/userguide/run-manage-matching-workflow.html) in the AWS Entity Resolution documentation.

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/integration-mobile-client-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ The following diagram shows the data flow that the publisher must implement for

This example uses the [SDK for Android](../sdks/sdk-ref-android.md) in the client-side mobile app and the [SDK for Java](../sdks/sdk-ref-java.md) on the server side.

![Mobile Client-Server Integration Example](images/integration-mobile-client-server.png)
![Mobile Client-Server Integration Example](images/integration-mobile-client-server-uid2.png)

<!-- (**GWH_ https://ttdcorp-my.sharepoint.com/:p:/r/personal/rita_aleksanyan_thetradedesk_com/_layouts/15/Doc.aspx?sourcedoc=%7BDF894943-3D6A-4A60-A1E2-176ACD0BBBCC%7D&file=Sample%20Data%20Flow.pptx&wdLOR=c8FEF9DB2-E2FD-4F07-B411-B094C4813ACE&fromShare=true&action=edit&mobileredirect=true**) -->

Expand Down
3 changes: 2 additions & 1 deletion docs/guides/integration-mobile-client-side.md
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,7 @@ You can pass the user’s <Link href="../ref-info/glossary-uid#gl-dii">DII</Link
The SDK encrypts the hashed DII before sending it to the UID2 service.
You can invoke the `generateIdentity` method using any of the four accepted formats for DII, for any specific user. The DII format might vary per user, but you can only send one value per user.
You can invoke the `generateIdentity` method using one of the four accepted formats for DII, for any specific user. The DII format might vary per user, but you can only send one value per user.
The following examples demonstrate the different ways that you can configure the UID2 mobile SDK and list the requirements for the DII passed into the SDK:
Expand Down Expand Up @@ -704,6 +704,7 @@ If the response status indicates that the DII has been opted out of UID2, you mi
## Optional: UID2 Prebid Mobile SDK Integration
:::important
The UID2 Prebid Mobile SDK integration requires version 1.4.0 of the UID2 SDK for Android, or version 1.5.0 of the UID2 SDK for iOS.
:::
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/integration-mobile-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: UID2 Mobile Integration Overview for Android and iOS
sidebar_label: Integration Overview for Mobile
pagination_label: Mobile Integration Overview for Android and iOS
description: Overview of options for UID2 mobile integration.
description: Overview of options for UID2 mobile integration.
hide_table_of_contents: false
sidebar_position: 04
displayed_sidebar: sidebarPublishers
Expand Down
6 changes: 2 additions & 4 deletions docs/sdks/sdk-ref-javascript.md
Original file line number Diff line number Diff line change
Expand Up @@ -331,11 +331,10 @@ There are two exceptions to this functionality:

:::note

If `useCookie` is updated, the location of the identity changes. For example, if the value is updated from `true` to `false`, the first party cookie is removed and the identity is added to local storage.
If `useCookie` is updated, the location of the identity changes. For example, if the value is updated from `true` to `false`, the first-party cookie is removed and the identity is added to local storage.

:::


### Init Config

Calling `init()` stores an init config in a first-party cookie or local storage which can include the following parameters if given: `baseUrl`, `useCookie`, `refreshRetryPeriod`, `cookiePath`, and `cookieDomain`. This config is used to [bootstrap init](#self-bootstrap) and save load time in future page loads. Subsequent calls to `init()` update the config with the most recent parameters.
Expand All @@ -344,7 +343,6 @@ Calling `init()` stores an init config in a first-party cookie or local storage

When the constructor has completed and the SDK has been put on the window object, the code will check local storage and cookie storage for a stored [init config](#init-config). If the config exists, `init()` is automatically called with the parameters from the config, and as a result, any functions that require `init()` can be used.


#### Errors

The `init()` function can throw the following errors.
Expand Down Expand Up @@ -602,4 +600,4 @@ window.__uid2.callbacks.push((eventType) => {

If you have decided to use `async` or `defer` script loading, move the script tag that loads the SDK into the document header and add the appropriate keyword.

Deciding to use `async` or `defer` script loading is not something the UID2 team can provide advice on, because it depends on the individual website. If you're not sure, it is safe to ignore this change and leave your script tag unchanged.
Deciding to use `async` or `defer` script loading is not something the UID2 team can provide advice on, because it depends on the individual website. If you're not sure, it is safe to ignore this change and leave your script tag unchanged.
2 changes: 1 addition & 1 deletion docs/snippets/_mobile_docs_prebid-mobile.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Prebid then sends the UID2 tokens into the RTB bidstream, along with other exter
This integration requires a Prebid Server setup.
:::

To configure your UID2 Prebid for Mobile integration, follow the steps below.
To configure your UID2 Prebid for Mobile integration, follow these steps:

1. Set up Prebid's Mobile SDK, following the steps in [Prebid SDK Integration for Android](https://docs.prebid.org/prebid-mobile/pbm-api/android/code-integration-android.html) or [Prebid SDK Integration for iOS](https://docs.prebid.org/prebid-mobile/pbm-api/ios/code-integration-ios.html).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ UID2 は、[Android](../sdks/sdk-ref-android.md) および [iOS](../sdks/sdk-ref

この例では、Client-Side のモバイルアプリで [SDK for Android](../sdks/sdk-ref-android.md) を使用し、Server-Side で [SDK for Java](../sdks/sdk-ref-java.md) を使用しています。

![Mobile Client-Server Integration Example](images/integration-mobile-client-server.png)
![Mobile Client-Server Integration Example](images/integration-mobile-client-server-uid2.png)

<!-- (**GWH_ https://ttdcorp-my.sharepoint.com/:p:/r/personal/rita_aleksanyan_thetradedesk_com/_layouts/15/Doc.aspx?sourcedoc=%7BDF894943-3D6A-4A60-A1E2-176ACD0BBBCC%7D&file=Sample%20Data%20Flow.pptx&wdLOR=c8FEF9DB2-E2FD-4F07-B411-B094C4813ACE&fromShare=true&action=edit&mobileredirect=true**) -->

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -704,6 +704,7 @@ If the response status indicates that the DII has been opted out of UID2, you mi


## Optional: UID2 Prebid Mobile SDK Integration

:::important
UID2 Prebid Mobile SDK インテグレーションは、Android のみに対応しています。UID2 Prebid Mobile SDK インテグレーションを実装するには、SDK for Android のバージョン 1.4.0 が必要です。
:::
Expand Down

0 comments on commit 750fca3

Please sign in to comment.