Merge branch 'ADP-1386-Custom-stores-server-side-api' into develop

* ADP-1386-Custom-stores-server-side-api: Installation Meta - a separate object
adaptyteam · Nov 4, 2024 · 46be837 · 46be837
2 parents 49646c6 + dcbe17d
commit 46be837
Show file tree

Hide file tree

Showing 3 changed files with 50 additions and 31 deletions.
diff --git a/versioned_docs/version-3.0/reusable/InstallationMeta.md b/versioned_docs/version-3.0/reusable/InstallationMeta.md
@@ -0,0 +1,18 @@
+
+
+
+
+| Parameter          | Type   | Required in request | Nullable in request | Description                                                  |
+| :----------------- | :----- | ------------------- | ------------------- | :----------------------------------------------------------- |
+| device_id          | String | :heavy_plus_sign:   | :heavy_minus_sign:  | The device identifier is generated on the client side        |
+| device             | String | :heavy_minus_sign:  | :heavy_plus_sign:   | The end-user-visible device model name.                      |
+| locale             | String | :heavy_minus_sign:  | :heavy_plus_sign:   | The locale used by the end user                              |
+| os                 | String | :heavy_minus_sign:  | :heavy_plus_sign:   | The operating system used by the end user                    |
+| platform           | String | :heavy_minus_sign:  | :heavy_plus_sign:   | The device platform used by the end user                     |
+| timezone           | String | :heavy_minus_sign:  | :heavy_plus_sign:   | The timezone of the end user                                 |
+| user_agent         | String | :heavy_minus_sign:  | :heavy_plus_sign:   | Details about the end user environment: device, operating system, and browser information of the end user interacting with your application |
+| idfa               | String | :heavy_minus_sign:  | :heavy_plus_sign:   | The Identifier for Advertisers, assigned by Apple to a user's device. |
+| idfv               | String | :heavy_minus_sign:  | :heavy_plus_sign:   | The Identifier for Vendors (IDFV) is a code assigned to all apps by one developer and is shared across all apps by that developer on your device. |
+| advertising_id     | String | :heavy_minus_sign:  | :heavy_plus_sign:   | The Advertising ID is a unique identifier offered by the Android Operating System that advertisers might use to uniquely identify you. |
+| android_id         | String | :heavy_minus_sign:  | :heavy_plus_sign:   | On Android 8.0 (API level 26) and higher versions of the platform, a 64-bit number (expressed as a hexadecimal string), unique to each combination of app-signing key, user, and device. For more details, see [Android developer documentation](https://developer.android.com/reference/android/provider/Settings.Secure#ANDROID_ID). |
+| android_app_set_id | String | :heavy_minus_sign:  | :heavy_plus_sign:   | An [AppSetId](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/appsetid/AppSetId) - unique, per-device, per developer-account user-resettable ID for non-monetizing advertising use cases. |
diff --git a/versioned_docs/version-3.0/reusable/ProfileRequest.md b/versioned_docs/version-3.0/reusable/ProfileRequest.md
@@ -12,16 +12,5 @@
 | store_country      | String        | :heavy_minus_sign:  | :heavy_plus_sign:   | Country of the end user app store                            |
 | store              | String        | :heavy_minus_sign:  | :heavy_plus_sign:   | The app store                                                |
 | analytics_disabled | Boolean       | :heavy_minus_sign:  | :heavy_minus_sign:  | <p>Optoon to [opt out external analytics](analytics-integration#disabling-external-analytics-for-a-specific-customer). If you disable analytics, then events will not be sent to integrations, and the idfa, idfv, advertising_id fields will become nullable.</p><p>ON - External analytics is opted out for this end user</p><p>OFF - Analytics works by default</p> |
-| custom_attributes  | Dictionary    | :heavy_minus_sign:  | :heavy_minus_sign:  | <p>A maximum of 30 custom attributes for the profile are allowed to be set. If you provide the `custom_attributes` disctionary, you must provide at least one atttribute key.</p><p>**Key**: The key must be a string with no more than 30 characters. Only letters, numbers, dashes, points and underscores allowed</p><p>**Value**: The attribute value must be no more than 30 characters. Only strings and floats are allowed as values, booleans will be converted to floats. Send an empty value or null to delete the attribute.</p> |
-| device_id          | String        | :heavy_minus_sign:  | :heavy_minus_sign:  | The device identifier is generated on the client side        |
-| device             | String        | :heavy_minus_sign:  | :heavy_plus_sign:   | The end-user-visible device model name.                      |
-| locale             | String        | :heavy_minus_sign:  | :heavy_plus_sign:   | The locale used by the end user                              |
-| os                 | String        | :heavy_minus_sign:  | :heavy_plus_sign:   | The operating system used by the end user                    |
-| platform           | String        | :heavy_minus_sign:  | :heavy_plus_sign:   | The device platform used by the end user                     |
-| timezone           | String        | :heavy_minus_sign:  | :heavy_plus_sign:   | The timezone of the end user                                 |
-| user_agent         | String        | :heavy_minus_sign:  | :heavy_plus_sign:   | Details about the end user environment: device, operating system, and browser information of the end user interacting with your application |
-| idfa               | String        | :heavy_minus_sign:  | :heavy_plus_sign:   | The Identifier for Advertisers, assigned by Apple to a user's device. |
-| idfv               | String        | :heavy_minus_sign:  | :heavy_plus_sign:   | The Identifier for Vendors (IDFV) is a code assigned to all apps by one developer and is shared across all apps by that developer on your device. |
-| advertising_id     | String        | :heavy_minus_sign:  | :heavy_plus_sign:   | The Advertising ID is a unique identifier offered by the Android Operating System that advertisers might use to uniquely identify you. |
-| android_id         | String        | :heavy_minus_sign:  | :heavy_plus_sign:   | On Android 8.0 (API level 26) and higher versions of the platform, a 64-bit number (expressed as a hexadecimal string), unique to each combination of app-signing key, user, and device. For more details, see [Android developer documentation](https://developer.android.com/reference/android/provider/Settings.Secure#ANDROID_ID). |
-| android_app_set_id | String        | :heavy_minus_sign:  | :heavy_plus_sign:   | An [AppSetId](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/appsetid/AppSetId) - unique, per-device, per developer-account user-resettable ID for non-monetizing advertising use cases. |
+| custom_attributes  | Disctionary   | :heavy_minus_sign:  | :heavy_minus_sign:  | <p>A maximum of 30 custom attributes for the profile are allowed to be set. If you provide the `custom_attributes` disctionary, you must provide at least one atttribute key.</p><p>**Key**: The key must be a string with no more than 30 characters. Only letters, numbers, dashes, points and underscores allowed</p><p>**Value**: The attribute value must be no more than 30 characters. Only strings and floats are allowed as values, booleans will be converted to floats. Send an empty value or null to delete the attribute.</p> |
+| installation_meta  | Dictionary    | :heavy_minus_sign:  | :heavy_minus_sign:  | Data on the specific app on a specific device as a dictionary of [Installation Meta](server-side-api-objects#installation-meta) objects. |
diff --git a/versioned_docs/version-3.0/server-side-api-objects.md b/versioned_docs/version-3.0/server-side-api-objects.md
@@ -12,26 +12,14 @@ import Subscription from './reusable/Subscription.md';
 import NonSubscription from './reusable/NonSubscription.md';
 import Offer from './reusable/Offer.md';
 import Price from './reusable/Price.md';
+import InstallationMeta from './reusable/InstallationMeta.md';
 
 ## Objects
 
 Adapty API has JSON objects so you can understand a response structure and wrap it into your code.
 
 All datetime values are [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example, "2020-01-15T15:10:36.517975+0000".
 
-### Profile
-
-Info about the [customer and their subscription](server-side-api-objects#profile)
-
-You can do the following actions with user profiles via Adapty server-side API:
-
-- [Retrieve/get end user's profile](server-side-api-specs#retrieve-profile) with their access levels, subscriptions, non-subscriptions, etc.
-- [Create a new end user profile](server-side-api-specs#create-profile)
-- [Update your end-user profile](server-side-api-specs#update-profile)
-- [Delete your end user](server-side-api-specs#delete-profile)
-
-<ProfileObject />
-
 ### Access level
 
 Info about customer’s [access level](access-level). 
@@ -47,14 +35,16 @@ You can do the following action via Adapty server-side API:
 
 <AccessLevel />
 
-### Subscription
+### Installation Meta
 
-Info about your end user subscription.  You can do the following action via Adapty server-side API:
+Information about installation of the app on a specific device. 
 
-- [Check user's current subscription](server-side-api-specs#retrieve-profile) by retrieving their profile details
-- [Set transaction to your user](server-side-api-specs#set-transaction) and grant a subscription to them
+You can do the following action via Adapty server-side API:
 
-<Subscription />
+- [Create a profile with spesific installation meta](server-side-api-specs#create-profile)
+- [Update user's installation meta](server-side-api-specs#update-profile)
+
+<InstallationMeta />
 
 ### Non Subscription
 
@@ -89,3 +79,25 @@ You can do the following actions with product price via Adapty server-side API:
 - [Set transaction to your user](server-side-api-specs#set-transaction) and specify its price
 
 <Price />
+
+### Profile
+
+Info about the [customer and their subscription](server-side-api-objects#profile)
+
+You can do the following actions with user profiles via Adapty server-side API:
+
+- [Retrieve/get end user's profile](server-side-api-specs#retrieve-profile) with their access levels, subscriptions, non-subscriptions, etc.
+- [Create a new end user profile](server-side-api-specs#create-profile)
+- [Update your end-user profile](server-side-api-specs#update-profile)
+- [Delete your end user](server-side-api-specs#delete-profile)
+
+<ProfileObject />
+
+### Subscription
+
+Info about your end user subscription.  You can do the following action via Adapty server-side API:
+
+- [Check user's current subscription](server-side-api-specs#retrieve-profile) by retrieving their profile details
+- [Set transaction to your user](server-side-api-specs#set-transaction) and grant a subscription to them
+
+<Subscription />