## Generate document --- This method generates the document that is defined for the provided slug. Inserts are processed. | | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** | | --- | --- | --- | --- | --- | | Introduced in: | 4.13.0 | 5.5.0 | 0.17.0 | 0.6.0 |
The API key must have the `SCHEMA_SERVICE_SCHEMA_READ` permission from the **Schema** group.
**Related To:** [Document](/developers/mobile-sdk/class-reference/android/recommendations-and-documents#document) **Class:** [Content](/developers/mobile-sdk/class-reference/android/modules#content) **Declaration:**
```java public static IDataApiCall generateDocument(String slugName) ```
**Parameters:** | Parameter | Type | Mandatory | Default | Description | | --- | --- | --- | --- | --- | | **slugName** | String | yes | - | Slug of the document | **Return Value:** [IDataApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#idataapicall) \ object to execute the request. **Example:**
```java apiCall = Content.generateDocument("slug"); apiCall.execute(this::onSuccess, this::onFailure); ```
```kotlin apiCall = Content.generateDocument("slug") apiCall.execute(({ this.onSuccess() }), ({ this.onFailure() })) ```
## Generate document with query parameters --- This method generates the document that is defined for the parameters provided in the query object. | | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** | | --- | --- | --- | --- | --- | | Introduced in: | 4.18.0 | 5.19.0 | 0.22.0 | 1.2.0 |
The API key must have the `SCHEMA_SERVICE_SCHEMA_READ` permission from the **Schema** group.
**Related To:** [DocumentApiQuery](/developers/mobile-sdk/class-reference/android/recommendations-and-documents#documentapiquery) [Document](/developers/mobile-sdk/class-reference/android/recommendations-and-documents#document) **Class:** [Content](/developers/mobile-sdk/class-reference/android/modules#content) **Declaration:**
```java public static IDataApiCall generateDocument(DocumentApiQuery documentApiQuery) ```
**Parameters:** | Parameter | Type | Mandatory | Default | Description | | --- | --- | --- | --- | --- | | **apiQuery** | [DocumentApiQuery](/developers/mobile-sdk/class-reference/android/recommendations-and-documents#documentapiquery) | yes | - | Object that stores all query parameters | **Return Value:** [IDataApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#idataapicall) \ object to execute the request. ## Get recommendations (v2) --- This method generates recommendations that are defined for the options provided. The recommendations are generated by using a document with an insert. For instructions, see ["Displaying AI recommendations > With documents and screen views"](/developers/mobile-sdk/displaying-recommendations/documents). | | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** | | --- | --- | --- | --- | --- | | Introduced in: | 4.13.0 | 5.5.0 | 0.17.0 | 0.6.0 |
The API key must have the `SCHEMA_SERVICE_SCHEMA_READ` permission from the **Schema** group.
**Related To:** [RecommendationRequestBody](/developers/mobile-sdk/class-reference/android/recommendations-and-documents#recommendationrequestbody) [RecommendationResponse](/developers/mobile-sdk/class-reference/android/recommendations-and-documents#recommendationresponse) **Class:** [Content](/developers/mobile-sdk/class-reference/android/modules#content) **Declaration:**
```java public static IDataApiCall getRecommendations(String slugName, RecommendationRequestBody options) ```
**Parameters:** | Parameter | Type | Mandatory | Default | Description | | --- | --- | --- | --- | --- | | **slugName** | String | yes | - | Slug of the document | | **options** | [RecommendationRequestBody](/developers/mobile-sdk/class-reference/android/recommendations-and-documents#recommendationrequestbody) | yes | - | Object which stores the ID of an item to generate recommendations for. | **Return Value:** [IDataApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#idataapicall)<[RecommendationResponse](/developers/mobile-sdk/class-reference/android/recommendations-and-documents#recommendationresponse)> object to execute the request. **Example:**
```java RecommendationRequestBody requestBody = new RecommendationRequestBody(); requestBody.setProductId("1"); String slugName = "testSlugName"; apiCall = Content.getRecommendationsV2(slugName, requestBody); apiCall.execute(this::onSuccess, this::onFailure); ```
```kotlin val requestBody = RecommendationRequestBody() requestBody.setProductId("1") val slugName = "testSlugName" apiCall = Content.getRecommendationsV2(slugName, requestBody) apiCall.execute(({ this.onSuccess() }), ({ this.onFailure() })) ```
## Generate screen view --- This method generates a customer's highest-priority screen view campaign from the feed with the provided feed slug. | | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** | | --- | --- | --- | --- | --- | | Introduced in: | 4.13.0 | 5.5.0 | 0.17.0 | 0.6.0 |
The API key must have the `SCHEMA_SERVICE_SCHEMA_READ` permission from the **Schema** group.
**Related To:** [ScreenView](/developers/mobile-sdk/class-reference/android/miscellaneous#screenview) **Class:** [Content](/developers/mobile-sdk/class-reference/android/modules#content) **Declaration:**
```java public static IDataApiCall generateScreenView(String feedSlug) ```
**Parameters:** | Parameter | Type | Mandatory | Default | Description | | --- | --- | --- | --- | --- | | **feedSlug** | String | yes | - | Identifies a specific screen view feed | **Return Value:** [IDataApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#idataapicall) \ object to execute the request. ## Generate screen view with query parameters --- This method generates customer's highest-priority screen view campaign that is defined for parameters provided in the query object. **Related To:** [ScreenViewApiQuery](/developers/mobile-sdk/class-reference/android/miscellaneous#screenviewapiquery) [ScreenView](/developers/mobile-sdk/class-reference/android/miscellaneous#screenview) **Class:** [Content](/developers/mobile-sdk/class-reference/android/modules#content) **Declaration:**
```java public static IDataApiCall generateScreenView(ScreenViewApiQuery screenViewApiQuery) ```
**Parameters:** | Parameter | Type | Mandatory | Default | Description | | --- | --- | --- | --- | --- | | **apiQuery** | [ScreenViewApiQuery](/developers/mobile-sdk/class-reference/android/miscellaneous#screenviewapiquery) | yes | - | Object that stores all query parameters | **Return Value:** [IDataApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#idataapicall) \ object to execute the request. ## Generate Brickworks --- This method generates content from a published version of a [Brickworks](/docs/assets/brickworks) record. Inserts and fields which require a customer context fetch it automatically from the current user. The output is a JSON object with a response from the Brickworks API. See [/brickworks/v1/schemas/{SchemaIdentifier}/records/{RecordIdentifier}/generate](https://hub.synerise.com/api-reference/brickworks#tag/Brickworks%3A-Content-generation/operation/generateObject). | | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** | | ----------------------------------------------- | ----------- | --------------- | -------------------- | --------------- | | Introduced in: | 5.8.1 | 6.8.0 | 1.6.0 | 2.6.0 |
The API key must have the `BRICKWORKS_RECORDS_READ` permission from the **RECORDS** group.
**Related To:** [BrickworksApiQuery](/developers/mobile-sdk/class-reference/android/miscellaneous#brickworksapiquery) **Class:** [Content](/developers/mobile-sdk/class-reference/android/modules#content) **Declaration:** 
public static IDataApiCall<Object> generateBrickworks(BrickworksApiQuery brickworksApiQuery)
**Parameters** | Parameter | Type | Mandatory | Default | Description | | ------------ | --------------------------------------------------------------------- | --------- | ------- | -------------------------------- | | **apiQuery** | [BrickworksApiQuery](/developers/mobile-sdk/class-reference/android) | yes | - | Object with all query parameters | **Return Value:** [IDataApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#idataapicall) object to execute the request. ## Removed methods ### Get document {#get-document} --- This method generates the document that is defined for the provided slug. | | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** | | --- | --- | --- | --- | --- | | Introduced in: | 3.4.8 | 3.4.2 | 0.9.10 | 0.2.0 | | Deprecated in: | 4.13.0 | 5.5.0 | 0.17.0 | 0.6.0 | | Removed in: | 5.0.0 | 6.0.0 | 1.0.0 | 2.0.0 |
The API key must have the `SCHEMA_SERVICE_DOCUMENT_READ` permission from the **Document** group.
**Class:** [Content](/developers/mobile-sdk/class-reference/android/modules#content) **Declaration**
```java public static IDataApiCall getDocument(String slugName) ``` **Parameters** | Parameter | Type | Mandatory | Default | Description | | --- | --- | --- | --- | --- | | **slugName** | String | yes | - | Slug of the document | **Return Value** [IDataApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#idataapicall) \ object to execute the request. **Example**
```java apiCall = Content.getDocument("slug"); apiCall.execute(this::onSuccess, this::onFailure); ```
```kotlin apiCall = Content.getDocument("slug") apiCall.execute(({ this.onSuccess() }), ({ this.onFailure() })) ```
### Get documents {#get-documents} --- This method generates documents that are defined for parameters provided in the query object. | | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** | | --- | --- | --- | --- | --- | | Removed in: | 5.0.0 | 6.0.0 | 1.0.0 | 2.0.0 |
The API key must have the `SCHEMA_SERVICE_DOCUMENT_READ` permission from the **Document** group.
**Class:** [Content](/developers/mobile-sdk/class-reference/android/modules#content) **Declaration**
```java public static IDataApiCall> getDocument(DocumentsApiQuery documentsApiQuery) ```
**Parameters** | Parameter | Type | Mandatory | Default | Description | | --- | --- | --- | --- | --- | | **documentsApiQuery** | [DocumentsApiQuery](/developers/mobile-sdk/class-reference/android/recommendations-and-documents#documentsapiquery) | yes | - | Object for configuration of the query parameters | **Return Value** [IDataApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#idataapicall) \> object to execute the request. **Example**
```java DocumentsApiQuery documentsApiQuery = new DocumentsApiQuery(); documentsApiQuery.setVersion("1.0.0"); documentsApiQuery.setDocumentQueryParameters(DocumentsApiQueryType.SCHEMA, "promotions"); apiCall = Content.getDocuments(documentsApiQuery); apiCall.execute(this::onSuccess, this::onFailure); ```
```kotlin val documentsApiQuery = DocumentsApiQuery() documentsApiQuery.setVersion("1.0.0") documentsApiQuery.setDocumentQueryParameters(DocumentsApiQueryType.SCHEMA, "promotions") apiCall = Content.getDocuments(documentsApiQuery) apiCall.execute(({ this.onSuccess() }), ({ this.onFailure() })) ```
### Get recommendations {#get-recommendations} --- This method generates recommendations that are defined for the options provided. | | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** | | --- | --- | --- | --- | --- | | Removed in: | 5.0.0 | 6.0.0 | 1.0.0 | 2.0.0 |
The API key must have the `SCHEMA_SERVICE_DOCUMENT_READ` permission from the **Document** group.
**Related To:** [RecommendationResponse](/developers/mobile-sdk/class-reference/android/recommendations-and-documents#recommendationresponse) **Class:** [Content](/developers/mobile-sdk/class-reference/android/modules#content) **Declaration**
```java public static IDataApiCall getRecommendations(String slugName, RecommendationRequestBody options) ```
**Parameters** | Parameter | Type | Mandatory | Default | Description | | --- | --- | --- | --- | --- | | **slugName** | String | yes | - | Slug of the document | | **options** | [RecommendationRequestBody](/developers/mobile-sdk/class-reference/android/recommendations-and-documents#recommendationrequestbody) | yes | - | Object which stores the ID of an item to generate recommendations for. | **Return Value** [IDataApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#idataapicall)<[RecommendationResponse](/developers/mobile-sdk/class-reference/android/recommendations-and-documents#recommendationresponse)> object to execute the request. **Example**
```java RecommendationRequestBody requestBody = new RecommendationRequestBody(); requestBody.setProductId("1"); String slugName = "testSlugName"; apiCall = Content.getRecommendations(slugName, requestBody); apiCall.execute(this::onSuccess, this::onFailure); ```
```kotlin val requestBody = RecommendationRequestBody() requestBody.setProductId("1") val slugName = "testSlugName" apiCall = Content.getRecommendations(slugName, requestBody) apiCall.execute(({ this.onSuccess() }), ({ this.onFailure() })) ```
### Get screen view {#get-screen-view} --- This method generates the customer's highest-priority screen view campaign. | | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** | | --- | --- | --- | --- | --- | | Introduced in: | 3.7.1 | 3.7.1 | 0.9.10 | 0.2.0 | | Deprecated in: | 4.13.0 | 5.5.0 | 0.17.0 | 0.6.0 | | Removed in: | 5.0.0 | 6.0.0 | 1.0.0 | 2.0.0 |
The API key must have the `SCHEMA_SERVICE_SCHEMA_READ` permission from the **Schema** group.
**Related To:** ScreenViewResponse (class removed in version 6.0.0) **Class:** [Content](/developers/mobile-sdk/class-reference/android/modules#content) **Declaration**
```java public static IDataApiCall getScreenView() ```
**Parameters** There are no parameters. **Return Value** [IDataApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#idataapicall) object to execute the request. **Example**
```java apiCall = Content.getScreenView(); apiCall.execute(this::onSuccess, this::onFailure); ```
```kotlin apiCall = Content.getScreenView() apiCall.execute(({ this.onSuccess() }), ({ this.onFailure() })) ```