Skip to content

Commit 13fec3a

Browse files
committed
Update README: rename sandbox to DCN
1 parent f37129c commit 13fec3a

1 file changed

Lines changed: 17 additions & 17 deletions

File tree

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Optable Android SDK [![](https://jitci.com/gh/Optable/optable-android-sdk/svg)](https://jitci.com/gh/Optable/optable-android-sdk)
22

3-
Kotlin SDK for integrating with optable-sandbox from an Android application.
3+
Kotlin SDK for integrating with an [Optable Data Connectivity Node (DCN)](https://docs.optable.co) from an Android application.
44

55
## Contents
66

@@ -54,7 +54,7 @@ Remember to replace `VERSION_TAG` with the latest or desired [SDK release](https
5454

5555
## Using
5656

57-
To configure an instance of the SDK integrating with an [Optable](https://optable.co/) sandbox running at hostname `sandbox.customer.com`, from a configured application origin identified by slug `my-app`, you can instantiate the SDK from an Activity or Application `Context`, such as for example the following application `MainActivity`:
57+
To configure an instance of the SDK integrating with an [Optable](https://optable.co/) DCN running at hostname `dcn.customer.com`, from a configured application origin identified by slug `my-app`, you can instantiate the SDK from an Activity or Application `Context`, such as for example the following application `MainActivity`:
5858

5959
#### Kotlin
6060

@@ -71,7 +71,7 @@ class MainActivity : AppCompatActivity() {
7171
super.onCreate(savedInstanceState)
7272
setContentView(R.layout.activity_main)
7373
...
74-
MainActivity.OPTABLE = OptableSDK(this, "sandbox.customer.com", "my-app")
74+
MainActivity.OPTABLE = OptableSDK(this, "dcn.customer.com", "my-app")
7575
...
7676
}
7777
}
@@ -92,32 +92,32 @@ public class MainActivity extends AppCompatActivity {
9292
setContentView(R.layout.activity_main);
9393
...
9494
MainActivity.OPTABLE = new OptableSDK(this.getApplicationContext(),
95-
"sandbox.customer.com", "my-app");
95+
"dcn.customer.com", "my-app");
9696
...
9797
}
9898
}
9999
```
100100

101-
You can then call various SDK APIs on the instance as shown in the examples below. It's also possible to configure multiple instances of `OptableSDK` in order to connect to other (e.g., partner) sandboxes and/or reference other configured application slug IDs.
101+
You can then call various SDK APIs on the instance as shown in the examples below. It's also possible to configure multiple instances of `OptableSDK` in order to connect to other (e.g., partner) DCNs and/or reference other configured application slug IDs.
102102

103-
Note that all SDK communication with Optable sandboxes is done over TLS. The only exception to this is if you instantiate the `OptableSDK` class with a fourth optional boolean parameter, `insecure`, set to `true`. For example, in Kotlin:
103+
Note that all SDK communication with Optable DCNs is done over TLS. The only exception to this is if you instantiate the `OptableSDK` class with a fourth optional boolean parameter, `insecure`, set to `true`. For example, in Kotlin:
104104

105105
```kotlin
106-
MainActivity.OPTABLE = OptableSDK(this, "sandbox.customer.com", "my-app", true)
106+
MainActivity.OPTABLE = OptableSDK(this, "dcn.customer.com", "my-app", true)
107107
```
108108

109-
However, since production sandboxes only listen to TLS traffic, the above is really only useful for developers of `optable-sandbox` running the sandbox locally for testing.
109+
However, since production DCNs only listen to TLS traffic, the above is meant for Optable developers running the DCN locally for testing.
110110

111-
By default, the SDK detects the application user agent by sniffing `settings.userAgentString` from a `WebView`. The resulting user agent string is sent to your sandbox for analytics purposes. To disable this behavior, you can provide an optional fifth string parameter `useragent`, which allows you to set whatever user agent string you would like to send instead. For example, in Kotlin:
111+
By default, the SDK detects the application user agent by sniffing `settings.userAgentString` from a `WebView`. The resulting user agent string is sent to your DCN for analytics purposes. To disable this behavior, you can provide an optional fifth string parameter `useragent`, which allows you to set whatever user agent string you would like to send instead. For example, in Kotlin:
112112

113113
```kotlin
114-
MainActivity.OPTABLE = OptableSDK(this, "sandbox.customer.com", "my-app", false, "custom-ua")
114+
MainActivity.OPTABLE = OptableSDK(this, "dcn.customer.com", "my-app", false, "custom-ua")
115115
```
116116

117117
Finally, an optional sixth boolean parameter `skipAdvertisingIdDetection` can be used to skip any ID info detection from `AdvertisingIdClient` which by default runs in a background co-routine. Disabling ad ID detection means that the SDK will not be able to automatically obtain the Google Advertising ID. For example, to disable ad ID detection, in Kotlin:
118118

119119
```kotlin
120-
MainActivity.OPTABLE = OptableSDK(this, "sandbox.customer.com", "my-app", false, null, true)
120+
MainActivity.OPTABLE = OptableSDK(this, "dcn.customer.com", "my-app", false, null, true)
121121
```
122122

123123
### Identify API
@@ -175,9 +175,9 @@ MainActivity.OPTABLE
175175
});
176176
```
177177

178-
The SDK `identify()` method will asynchronously connect to the configured sandbox and send IDs for resolution. The second (`sendGoogleAdIDBoolean`) and third (`ppid`) arguments to `identify()` are optional. You can register an observer to understand successful completion or errors.
178+
The SDK `identify()` method will asynchronously connect to the configured DCN and send IDs for resolution. The second (`sendGoogleAdIDBoolean`) and third (`ppid`) arguments to `identify()` are optional. You can register an observer to understand successful completion or errors.
179179

180-
> :warning: **Client-Side Email Hashing**: The SDK will compute the SHA-256 hash of the Email address on the client-side and send the hashed value to the sandbox. The Email address is **not** sent by the device in plain text.
180+
> :warning: **Client-Side Email Hashing**: The SDK will compute the SHA-256 hash of the Email address on the client-side and send the hashed value to the DCN. The Email address is **not** sent by the device in plain text.
181181
182182
Since the `sendGoogleAdIDBoolean` value provided to `identify()` is `true`, the SDK will fetch and send the Google Advertising ID in the call to `identify` too, unless the user has turned on "Limit ad tracking" in their Google device advertising settings.
183183

@@ -237,7 +237,7 @@ The specified traits are associated with the user's device and can be used for m
237237

238238
### Targeting API
239239

240-
To get the targeting key values associated by the configured sandbox with the device in real-time, you can call the `targeting` API as follows:
240+
To get the targeting key values associated by the configured DCN with the device in real-time, you can call the `targeting` API as follows:
241241

242242
#### Kotlin
243243

@@ -334,7 +334,7 @@ Note that both `targetingFromCache()` and `targetingClearCache()` are synchronou
334334

335335
### Witness API
336336

337-
To send real-time event data from the user's device to the sandbox for eventual audience assembly, you can call the witness API as follows:
337+
To send real-time event data from the user's device to the DCN for eventual audience assembly, you can call the witness API as follows:
338338

339339
#### Kotlin
340340

@@ -516,9 +516,9 @@ public void onCreate(Bundle savedInstanceState) {
516516

517517
## Demo Applications
518518

519-
The Kotlin and Java demo applications show a working example of `identify`, `targeting`, and `witness` APIs, as well as an integration with the [Google Ad Manager 360](https://admanager.google.com/home/) ad server, enabling the targeting of ads served by GAM360 to audiences activated in the [Optable](https://optable.co/) sandbox.
519+
The Kotlin and Java demo applications show a working example of `identify`, `targeting`, and `witness` APIs, as well as an integration with the [Google Ad Manager 360](https://admanager.google.com/home/) ad server, enabling the targeting of ads served by GAM360 to audiences activated in the [Optable](https://optable.co/) DCN.
520520

521-
By default, the demo applications will connect to the [Optable](https://optable.co/) demo sandbox at `sandbox.optable.co` and reference application slug `android-sdk-demo`. The demo apps depend on the [GAM Mobile Ads SDK for Android](https://developers.google.com/ad-manager/mobile-ads-sdk/android/quick-start) and load ads from a GAM360 account operated by [Optable](https://optable.co/).
521+
By default, the demo applications will connect to the [Optable](https://optable.co/) demo DCN at `sandbox.optable.co` and reference application slug `android-sdk-demo`. The demo apps depend on the [GAM Mobile Ads SDK for Android](https://developers.google.com/ad-manager/mobile-ads-sdk/android/quick-start) and load ads from a GAM360 account operated by [Optable](https://optable.co/).
522522

523523
### Building
524524

0 commit comments

Comments
 (0)