Skip to content
This repository was archived by the owner on Sep 19, 2022. It is now read-only.

Latest commit

 

History

History
1849 lines (1484 loc) · 83.2 KB

SellersV2Api.md

File metadata and controls

1849 lines (1484 loc) · 83.2 KB

SellersV2Api

All URIs are relative to https://api.criteo.com/marketing

Method HTTP request Description
createSellerBudgets POST /v2/crp/budgets Create a collection of budgets.
createSellerCampaignsBySeller POST /v2/crp/sellers/{sellerId}/seller-campaigns Create a SellerCampaign
createSellers POST /v2/crp/advertisers/{advertiserId}/sellers Create new sellers for an advertiser
getAdvertiser GET /v2/crp/advertisers/{advertiserId} Get an advertiser.
getAdvertiserCampaigns GET /v2/crp/advertisers/{advertiserId}/campaigns Get the collection of CRP campaigns associated with the advertiserId.
getAdvertiserPreviewLimits GET /v2/crp/advertisers/preview-limit Get the collection of advertisers preview limits associated with the authorized user.
getAdvertisers GET /v2/crp/advertisers Get the collection of advertisers associated with the user.
getBudgetsByAdvertiser GET /v2/crp/advertisers/{advertiserId}/budgets Get CRP budgets for a specific advertiser
getBudgetsBySeller GET /v2/crp/sellers/{sellerId}/budgets Get a collection of budgets for this seller.
getBudgetsBySellerCampaignId GET /v2/crp/seller-campaigns/{sellerCampaignId}/budgets Get a collection of budgets for this seller campaign.
getSeller GET /v2/crp/sellers/{sellerId} Get details for a seller.
getSellerAdDemo GET /v2/crp/advertisers/{advertiserId}/ad-preview Get a preview of an HTML ad with products belonging to the provided seller
getSellerBudget GET /v2/crp/budgets/{budgetId} Get details for a budget.
getSellerBudgets GET /v2/crp/budgets Get a collection of budgets.
getSellerCampaign GET /v2/crp/seller-campaigns/{sellerCampaignId} Get details for a seller campaign.
getSellerCampaigns GET /v2/crp/seller-campaigns Get a collection of seller campaigns.
getSellerCampaignsByAdvertiser GET /v2/crp/advertisers/{advertiserId}/seller-campaigns Get CRP seller-campaigns for a specific advertiser
getSellerCampaignsBySeller GET /v2/crp/sellers/{sellerId}/seller-campaigns Get a collection of seller campaigns for this seller.
getSellers GET /v2/crp/sellers Get a collection of sellers.
updateSellerBudget PATCH /v2/crp/budgets/{budgetId} Modify a single budget.
updateSellerBudgets PATCH /v2/crp/budgets Modify a collection of budgets.
updateSellerCampaign PATCH /v2/crp/seller-campaigns/{sellerCampaignId} Update an existing seller campaign.
updateSellerCampaigns PATCH /v2/crp/seller-campaigns Update a collection of seller campaigns.

createSellerBudgets

List<SellerBudgetMessage> createSellerBudgets(authorization, createSellerBudgets)

Create a collection of budgets.

Create one or more new budgets to enable spending with the given limitations. All three types of budgets can be created this way. The following constraints apply when creating a new budget. • <b>sellerId</b>: the seller MUST be supplied<br /> • <b>campaignIds</b>: a non-empty array of campaign ids MUST be supplied<br /> • <b>budgetType</b>: a budget type MUST be supplied<br /> • <b>amount</b>: an amount MAY be supplied only if the type is not Uncapped and if supplied it MUST be non-negative<br /> • <b>startDate</b>: a future start date MUST be supplied<br /> • <b>endDate</b>: an end date MAY be supplied and if supplied MUST be greater than the start date<br /> Other attributes MUST NOT be supplied.

Example

// Import classes:
import com.criteo.marketing.ApiClient;
import com.criteo.marketing.ApiException;
import com.criteo.marketing.Configuration;
import com.criteo.marketing.auth.*;
import com.criteo.marketing.models.*;
import com.criteo.marketing.api.SellersV2Api;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.criteo.com/marketing");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    SellersV2Api apiInstance = new SellersV2Api(defaultClient);
    String authorization = "\"Bearer VALID_JWT_TOKEN_BASE64\""; // String | JWT Bearer Token
    List<CreateSellerBudgetMapiMessage> createSellerBudgets = Arrays.asList(); // List<CreateSellerBudgetMapiMessage> | 
    try {
      List<SellerBudgetMessage> result = apiInstance.createSellerBudgets(authorization, createSellerBudgets);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SellersV2Api#createSellerBudgets");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
authorization String JWT Bearer Token [default to "Bearer VALID_JWT_TOKEN_BASE64"]
createSellerBudgets List<CreateSellerBudgetMapiMessage>

Return type

List<SellerBudgetMessage>

Authorization

Authorization

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, text/html
  • Accept: application/json, text/json, application/xml, text/xml, text/html

HTTP response details

Status code Description Response headers
200 OK -
401 Authentication failed. -
403 You do not have access to the requested records -
429 Throttling failure. Maximum sending rate exceeded. -
500 Unknown error. -

createSellerCampaignsBySeller

SellerCampaignMessage createSellerCampaignsBySeller(sellerId, authorization, sellerCampaign)

Create a SellerCampaign

Associate an existing Seller with an existing Campaign allowing for budget creation

Example

// Import classes:
import com.criteo.marketing.ApiClient;
import com.criteo.marketing.ApiException;
import com.criteo.marketing.Configuration;
import com.criteo.marketing.auth.*;
import com.criteo.marketing.models.*;
import com.criteo.marketing.api.SellersV2Api;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.criteo.com/marketing");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    SellersV2Api apiInstance = new SellersV2Api(defaultClient);
    String sellerId = "sellerId_example"; // String | Supply a generated Id of an existing Seller
    String authorization = "\"Bearer VALID_JWT_TOKEN_BASE64\""; // String | JWT Bearer Token
    CreateSellerCampaignMessageMapi sellerCampaign = new CreateSellerCampaignMessageMapi(); // CreateSellerCampaignMessageMapi | Supply the campaign Id and bid to create the mapping
    try {
      SellerCampaignMessage result = apiInstance.createSellerCampaignsBySeller(sellerId, authorization, sellerCampaign);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SellersV2Api#createSellerCampaignsBySeller");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
sellerId String Supply a generated Id of an existing Seller
authorization String JWT Bearer Token [default to "Bearer VALID_JWT_TOKEN_BASE64"]
sellerCampaign CreateSellerCampaignMessageMapi Supply the campaign Id and bid to create the mapping

Return type

SellerCampaignMessage

Authorization

Authorization

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, text/html
  • Accept: application/json, text/json, text/html

HTTP response details

Status code Description Response headers
200 OK -
401 Authentication failed. -
403 You do not have access to the requested records -
429 Throttling failure. Maximum sending rate exceeded. -
500 Unknown error. -

createSellers

List<SellerBase> createSellers(advertiserId, authorization, sellerNames, partnerId)

Create new sellers for an advertiser

Example

// Import classes:
import com.criteo.marketing.ApiClient;
import com.criteo.marketing.ApiException;
import com.criteo.marketing.Configuration;
import com.criteo.marketing.auth.*;
import com.criteo.marketing.models.*;
import com.criteo.marketing.api.SellersV2Api;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.criteo.com/marketing");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    SellersV2Api apiInstance = new SellersV2Api(defaultClient);
    Integer advertiserId = 56; // Integer | 
    String authorization = "\"Bearer VALID_JWT_TOKEN_BASE64\""; // String | JWT Bearer Token
    List<String> sellerNames = Arrays.asList(); // List<String> | 
    Integer partnerId = 56; // Integer | 
    try {
      List<SellerBase> result = apiInstance.createSellers(advertiserId, authorization, sellerNames, partnerId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SellersV2Api#createSellers");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
advertiserId Integer
authorization String JWT Bearer Token [default to "Bearer VALID_JWT_TOKEN_BASE64"]
sellerNames List<String>
partnerId Integer [optional]

Return type

List<SellerBase>

Authorization

Authorization

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, text/html
  • Accept: application/json, text/json, application/xml, text/xml, text/html

HTTP response details

Status code Description Response headers
200 OK -
401 Authentication failed. -
403 You do not have access to the requested records -
429 Throttling failure. Maximum sending rate exceeded. -
500 Unknown error. -

getAdvertiser

AdvertiserInfoMessage getAdvertiser(advertiserId, authorization)

Get an advertiser.

Example

// Import classes:
import com.criteo.marketing.ApiClient;
import com.criteo.marketing.ApiException;
import com.criteo.marketing.Configuration;
import com.criteo.marketing.auth.*;
import com.criteo.marketing.models.*;
import com.criteo.marketing.api.SellersV2Api;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.criteo.com/marketing");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    SellersV2Api apiInstance = new SellersV2Api(defaultClient);
    Integer advertiserId = 56; // Integer | 
    String authorization = "\"Bearer VALID_JWT_TOKEN_BASE64\""; // String | JWT Bearer Token
    try {
      AdvertiserInfoMessage result = apiInstance.getAdvertiser(advertiserId, authorization);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SellersV2Api#getAdvertiser");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
advertiserId Integer
authorization String JWT Bearer Token [default to "Bearer VALID_JWT_TOKEN_BASE64"]

Return type

AdvertiserInfoMessage

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, text/html

HTTP response details

Status code Description Response headers
200 OK -
401 Authentication failed. -
403 You do not have access to the requested records -
429 Throttling failure. Maximum sending rate exceeded. -
500 Unknown error. -

getAdvertiserCampaigns

List<AdvertiserCampaignMessage> getAdvertiserCampaigns(advertiserId, authorization)

Get the collection of CRP campaigns associated with the advertiserId.

Example

// Import classes:
import com.criteo.marketing.ApiClient;
import com.criteo.marketing.ApiException;
import com.criteo.marketing.Configuration;
import com.criteo.marketing.auth.*;
import com.criteo.marketing.models.*;
import com.criteo.marketing.api.SellersV2Api;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.criteo.com/marketing");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    SellersV2Api apiInstance = new SellersV2Api(defaultClient);
    Integer advertiserId = 56; // Integer | 
    String authorization = "\"Bearer VALID_JWT_TOKEN_BASE64\""; // String | JWT Bearer Token
    try {
      List<AdvertiserCampaignMessage> result = apiInstance.getAdvertiserCampaigns(advertiserId, authorization);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SellersV2Api#getAdvertiserCampaigns");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
advertiserId Integer
authorization String JWT Bearer Token [default to "Bearer VALID_JWT_TOKEN_BASE64"]

Return type

List<AdvertiserCampaignMessage>

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml, text/html

HTTP response details

Status code Description Response headers
200 OK -
401 Authentication failed. -
403 You do not have access to the requested records -
429 Throttling failure. Maximum sending rate exceeded. -
500 Unknown error. -

getAdvertiserPreviewLimits

List<AdvertiserQuotaMessage> getAdvertiserPreviewLimits(authorization)

Get the collection of advertisers preview limits associated with the authorized user.

Example

// Import classes:
import com.criteo.marketing.ApiClient;
import com.criteo.marketing.ApiException;
import com.criteo.marketing.Configuration;
import com.criteo.marketing.auth.*;
import com.criteo.marketing.models.*;
import com.criteo.marketing.api.SellersV2Api;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.criteo.com/marketing");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    SellersV2Api apiInstance = new SellersV2Api(defaultClient);
    String authorization = "\"Bearer VALID_JWT_TOKEN_BASE64\""; // String | JWT Bearer Token
    try {
      List<AdvertiserQuotaMessage> result = apiInstance.getAdvertiserPreviewLimits(authorization);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SellersV2Api#getAdvertiserPreviewLimits");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
authorization String JWT Bearer Token [default to "Bearer VALID_JWT_TOKEN_BASE64"]

Return type

List<AdvertiserQuotaMessage>

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml, text/html

HTTP response details

Status code Description Response headers
200 OK -
401 Authentication failed. -
403 You do not have access to the requested records -
429 Throttling failure. Maximum sending rate exceeded. -
500 Unknown error. -

getAdvertisers

List<AdvertiserInfoMessage> getAdvertisers(authorization)

Get the collection of advertisers associated with the user.

Example

// Import classes:
import com.criteo.marketing.ApiClient;
import com.criteo.marketing.ApiException;
import com.criteo.marketing.Configuration;
import com.criteo.marketing.auth.*;
import com.criteo.marketing.models.*;
import com.criteo.marketing.api.SellersV2Api;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.criteo.com/marketing");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    SellersV2Api apiInstance = new SellersV2Api(defaultClient);
    String authorization = "\"Bearer VALID_JWT_TOKEN_BASE64\""; // String | JWT Bearer Token
    try {
      List<AdvertiserInfoMessage> result = apiInstance.getAdvertisers(authorization);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SellersV2Api#getAdvertisers");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
authorization String JWT Bearer Token [default to "Bearer VALID_JWT_TOKEN_BASE64"]

Return type

List<AdvertiserInfoMessage>

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml, text/html

HTTP response details

Status code Description Response headers
200 OK -
401 Authentication failed. -
403 You do not have access to the requested records -
429 Throttling failure. Maximum sending rate exceeded. -
500 Unknown error. -

getBudgetsByAdvertiser

List<SellerBudgetMessage> getBudgetsByAdvertiser(advertiserId, authorization, status, withBalance, withSpend, endAfterDate, startBeforeDate, budgetId, sellerId, type)

Get CRP budgets for a specific advertiser

Example

// Import classes:
import com.criteo.marketing.ApiClient;
import com.criteo.marketing.ApiException;
import com.criteo.marketing.Configuration;
import com.criteo.marketing.auth.*;
import com.criteo.marketing.models.*;
import com.criteo.marketing.api.SellersV2Api;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.criteo.com/marketing");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    SellersV2Api apiInstance = new SellersV2Api(defaultClient);
    Integer advertiserId = 56; // Integer | 
    String authorization = "\"Bearer VALID_JWT_TOKEN_BASE64\""; // String | JWT Bearer Token
    String status = "status_example"; // String | 
    Boolean withBalance = true; // Boolean | 
    Boolean withSpend = true; // Boolean | 
    OffsetDateTime endAfterDate = new OffsetDateTime(); // OffsetDateTime | 
    OffsetDateTime startBeforeDate = new OffsetDateTime(); // OffsetDateTime | 
    Long budgetId = 56L; // Long | 
    Long sellerId = 56L; // Long | 
    String type = "type_example"; // String | 
    try {
      List<SellerBudgetMessage> result = apiInstance.getBudgetsByAdvertiser(advertiserId, authorization, status, withBalance, withSpend, endAfterDate, startBeforeDate, budgetId, sellerId, type);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SellersV2Api#getBudgetsByAdvertiser");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
advertiserId Integer
authorization String JWT Bearer Token [default to "Bearer VALID_JWT_TOKEN_BASE64"]
status String [optional] [enum: Archived, Current, Scheduled]
withBalance Boolean [optional]
withSpend Boolean [optional]
endAfterDate OffsetDateTime [optional]
startBeforeDate OffsetDateTime [optional]
budgetId Long [optional]
sellerId Long [optional]
type String [optional]

Return type

List<SellerBudgetMessage>

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml, text/html

HTTP response details

Status code Description Response headers
200 OK -
401 Authentication failed. -
403 You do not have access to the requested records -
429 Throttling failure. Maximum sending rate exceeded. -
500 Unknown error. -

getBudgetsBySeller

List<SellerBudgetMessage> getBudgetsBySeller(sellerId, authorization, status, withBalance, withSpend, endAfterDate, startBeforeDate, campaignId, type)

Get a collection of budgets for this seller.

Return a collection of budgets for this seller filtered by optional filter parameters. If all parameters are omitted the entire collection to which the user has access is returned, except those whose endDate is in the past. Returned budgets must satisfy all supplied filter criteria if multiple parameters are used. See the budgets endpoint for additional details.

Example

// Import classes:
import com.criteo.marketing.ApiClient;
import com.criteo.marketing.ApiException;
import com.criteo.marketing.Configuration;
import com.criteo.marketing.auth.*;
import com.criteo.marketing.models.*;
import com.criteo.marketing.api.SellersV2Api;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.criteo.com/marketing");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    SellersV2Api apiInstance = new SellersV2Api(defaultClient);
    String sellerId = "sellerId_example"; // String | Return only budgets belonging to the given seller.
    String authorization = "\"Bearer VALID_JWT_TOKEN_BASE64\""; // String | JWT Bearer Token
    String status = "status_example"; // String | Return only budgets with the given status.
    Boolean withBalance = true; // Boolean | Return only budgets with the given status.
    Boolean withSpend = true; // Boolean | Return budgets with any positive spend.
    OffsetDateTime endAfterDate = new OffsetDateTime(); // OffsetDateTime | Return budgets that end after the given date using the `yyyy-MM-DD` format.              If param is not provided, default behavior is to only return budgets that have not yet ended.
    OffsetDateTime startBeforeDate = new OffsetDateTime(); // OffsetDateTime | Return budgets that start on or before the given date using the `yyyy-MM-DD` format.
    Integer campaignId = 56; // Integer | Return only budgets that pay for a given campaign.
    String type = "type_example"; // String | Return only budgets with the given budget type.
    try {
      List<SellerBudgetMessage> result = apiInstance.getBudgetsBySeller(sellerId, authorization, status, withBalance, withSpend, endAfterDate, startBeforeDate, campaignId, type);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SellersV2Api#getBudgetsBySeller");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
sellerId String Return only budgets belonging to the given seller.
authorization String JWT Bearer Token [default to "Bearer VALID_JWT_TOKEN_BASE64"]
status String Return only budgets with the given status. [optional] [enum: Archived, Current, Scheduled]
withBalance Boolean Return only budgets with the given status. [optional]
withSpend Boolean Return budgets with any positive spend. [optional]
endAfterDate OffsetDateTime Return budgets that end after the given date using the `yyyy-MM-DD` format. If param is not provided, default behavior is to only return budgets that have not yet ended. [optional]
startBeforeDate OffsetDateTime Return budgets that start on or before the given date using the `yyyy-MM-DD` format. [optional]
campaignId Integer Return only budgets that pay for a given campaign. [optional]
type String Return only budgets with the given budget type. [optional]

Return type

List<SellerBudgetMessage>

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml, text/html

HTTP response details

Status code Description Response headers
200 OK -
400 List of errors encountered -
401 Authentication failed. -
403 You do not have access to the requested records -
429 Throttling failure. Maximum sending rate exceeded. -
500 Unknown error. -

getBudgetsBySellerCampaignId

List<SellerBudgetMessage> getBudgetsBySellerCampaignId(sellerCampaignId, authorization, status, withBalance, withSpend, endAfterDate, startBeforeDate, type)

Get a collection of budgets for this seller campaign.

Return a collection of budgets for this seller campaign filtered by optional filter parameters. If all parameters are omitted the entire collection to which the user has access is returned, except those whose endDate is in the past. Returned budgets must satisfy all supplied filter criteria if multiple parameters are used. See the budgets endpoint for additional details.

Example

// Import classes:
import com.criteo.marketing.ApiClient;
import com.criteo.marketing.ApiException;
import com.criteo.marketing.Configuration;
import com.criteo.marketing.auth.*;
import com.criteo.marketing.models.*;
import com.criteo.marketing.api.SellersV2Api;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.criteo.com/marketing");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    SellersV2Api apiInstance = new SellersV2Api(defaultClient);
    String sellerCampaignId = "sellerCampaignId_example"; // String | Return only budgets belonging to the given seller campaign.
    String authorization = "\"Bearer VALID_JWT_TOKEN_BASE64\""; // String | JWT Bearer Token
    String status = "status_example"; // String | Return only budgets with the given status.
    Boolean withBalance = true; // Boolean | Return only budgets with a positive balance.
    Boolean withSpend = true; // Boolean | Return budgets with a positive spend.
    OffsetDateTime endAfterDate = new OffsetDateTime(); // OffsetDateTime | Return budgets that end after the given date using the `yyyy-MM-DD` format.               If param is not provided, default behavior is to only return budgets that have not yet ended.
    OffsetDateTime startBeforeDate = new OffsetDateTime(); // OffsetDateTime | Return budgets that start on or before the given date using the `yyyy-MM-DD` format.
    String type = "type_example"; // String | Return only budgets with the given budget type.
    try {
      List<SellerBudgetMessage> result = apiInstance.getBudgetsBySellerCampaignId(sellerCampaignId, authorization, status, withBalance, withSpend, endAfterDate, startBeforeDate, type);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SellersV2Api#getBudgetsBySellerCampaignId");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
sellerCampaignId String Return only budgets belonging to the given seller campaign.
authorization String JWT Bearer Token [default to "Bearer VALID_JWT_TOKEN_BASE64"]
status String Return only budgets with the given status. [optional] [enum: Archived, Current, Scheduled]
withBalance Boolean Return only budgets with a positive balance. [optional]
withSpend Boolean Return budgets with a positive spend. [optional]
endAfterDate OffsetDateTime Return budgets that end after the given date using the `yyyy-MM-DD` format. If param is not provided, default behavior is to only return budgets that have not yet ended. [optional]
startBeforeDate OffsetDateTime Return budgets that start on or before the given date using the `yyyy-MM-DD` format. [optional]
type String Return only budgets with the given budget type. [optional]

Return type

List<SellerBudgetMessage>

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml, text/html

HTTP response details

Status code Description Response headers
200 OK -
400 List of errors encountered -
401 Authentication failed. -
403 You do not have access to the requested records -
429 Throttling failure. Maximum sending rate exceeded. -
500 Unknown error. -

getSeller

SellerBase getSeller(sellerId, authorization)

Get details for a seller.

Returns details for the selected seller. For example { &quot;id&quot; : &quot;123456&quot; &quot;sellerName&quot;: &quot;HBogart&quot;, }

Example

// Import classes:
import com.criteo.marketing.ApiClient;
import com.criteo.marketing.ApiException;
import com.criteo.marketing.Configuration;
import com.criteo.marketing.auth.*;
import com.criteo.marketing.models.*;
import com.criteo.marketing.api.SellersV2Api;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.criteo.com/marketing");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    SellersV2Api apiInstance = new SellersV2Api(defaultClient);
    String sellerId = "sellerId_example"; // String | Id of the seller.
    String authorization = "\"Bearer VALID_JWT_TOKEN_BASE64\""; // String | JWT Bearer Token
    try {
      SellerBase result = apiInstance.getSeller(sellerId, authorization);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SellersV2Api#getSeller");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
sellerId String Id of the seller.
authorization String JWT Bearer Token [default to "Bearer VALID_JWT_TOKEN_BASE64"]

Return type

SellerBase

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml, text/html

HTTP response details

Status code Description Response headers
200 OK -
400 List of errors encountered -
401 Authentication failed. -
403 You do not have access to the requested records -
429 Throttling failure. Maximum sending rate exceeded. -
500 Unknown error. -

getSellerAdDemo

String getSellerAdDemo(advertiserId, sellerId, authorization, campaignId, height, width)

Get a preview of an HTML ad with products belonging to the provided seller

• <b>advertiserId</b>: Valid crp advertiserId, seller belongs to provided advertiser<br /> • <b>sellerId</b>: Products from given SellerId will fill the ad preview, must be existing crp sellerId<br /> • <b>campaignId</b>: CampaignId may be supplied if there is a specific design set configured for the provided campaign, Seller-Campaign must be valid in crp<br /> • <b>height</b>: height may be supplied to request a specific ad preview height. Default height: 250<br /> • <b>width</b>: width may be supplied to request a specific ad preview width. Default width: 300<br /> Ad preview api calls are capped to 1000 per day per advertiser by default. Current usage, limit, and period can be found using v2/crp/advertisers/preview-limit

Example

// Import classes:
import com.criteo.marketing.ApiClient;
import com.criteo.marketing.ApiException;
import com.criteo.marketing.Configuration;
import com.criteo.marketing.auth.*;
import com.criteo.marketing.models.*;
import com.criteo.marketing.api.SellersV2Api;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.criteo.com/marketing");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    SellersV2Api apiInstance = new SellersV2Api(defaultClient);
    Integer advertiserId = 56; // Integer | 
    Long sellerId = 56L; // Long | 
    String authorization = "\"Bearer VALID_JWT_TOKEN_BASE64\""; // String | JWT Bearer Token
    Integer campaignId = 56; // Integer | 
    Integer height = 56; // Integer | 
    Integer width = 56; // Integer | 
    try {
      String result = apiInstance.getSellerAdDemo(advertiserId, sellerId, authorization, campaignId, height, width);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SellersV2Api#getSellerAdDemo");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
advertiserId Integer
sellerId Long
authorization String JWT Bearer Token [default to "Bearer VALID_JWT_TOKEN_BASE64"]
campaignId Integer [optional]
height Integer [optional]
width Integer [optional]

Return type

String

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml, text/html

HTTP response details

Status code Description Response headers
200 OK -
401 Authentication failed. -
403 You do not have access to the requested records -
429 Throttling failure. Maximum sending rate exceeded. -
500 Unknown error. -

getSellerBudget

SellerBudgetMessage getSellerBudget(budgetId, authorization)

Get details for a budget.

Return a budget. For example: { &quot;id&quot;: &quot;1759183&quot;, &quot;sellerId&quot;: &quot;321392&quot;, &quot;campaignIds&quot;: [ 143962 ], &quot;budgetType&quot;: &quot;Capped&quot;, &quot;amount&quot;: 1000, &quot;startDate&quot;: &quot;2021-01-11&quot;, &quot;endDate&quot;: &quot;2021-01-12&quot;, &quot;spend&quot;: null, &quot;status&quot;: &quot;Active&quot; } A budget limits the spend of a seller for one or more campaigns. There are three types of budget:<br /><b>Uncapped</b> budgets put no limit on the total amount of spend.<br /><b>Capped</b> budgets limit the total spend to a fixed amount.<br /><b>Daily</b> budgets limit daily spend to a fixed amount.<br /> In addition, budgets can limit the spend to a specific range of dates using the start and end date attributes. Finally a budget must be active to be used. <b>Spend</b> approximates the current spend against this budget. There may be a lag between when an ad is clicked and the time it accrues to the spend. Daily budgets show spend against the most recent day only.

Example

// Import classes:
import com.criteo.marketing.ApiClient;
import com.criteo.marketing.ApiException;
import com.criteo.marketing.Configuration;
import com.criteo.marketing.auth.*;
import com.criteo.marketing.models.*;
import com.criteo.marketing.api.SellersV2Api;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.criteo.com/marketing");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    SellersV2Api apiInstance = new SellersV2Api(defaultClient);
    Long budgetId = 56L; // Long | Id of the budget.
    String authorization = "\"Bearer VALID_JWT_TOKEN_BASE64\""; // String | JWT Bearer Token
    try {
      SellerBudgetMessage result = apiInstance.getSellerBudget(budgetId, authorization);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SellersV2Api#getSellerBudget");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
budgetId Long Id of the budget.
authorization String JWT Bearer Token [default to "Bearer VALID_JWT_TOKEN_BASE64"]

Return type

SellerBudgetMessage

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, text/html

HTTP response details

Status code Description Response headers
200 OK -
400 List of errors encountered -
401 Authentication failed. -
403 You do not have access to the requested records -
429 Throttling failure. Maximum sending rate exceeded. -
500 Unknown error. -

getSellerBudgets

List<SellerBudgetMessage> getSellerBudgets(authorization, status, withBalance, withSpend, endAfterDate, startBeforeDate, campaignId, sellerId, type, advertiserId)

Get a collection of budgets.

Return a collection of budgets filtered by optional filter parameters. If all parameters are omitted the entire collection to which the user has access is returned, except those whose endDate is in the past. Returned budgets must satisfy all supplied filter criteria if multiple parameters are used. <b>Date filter.</b> Filtering can return only budgets that were active for a date range by specifying the startBeforeDate and endAfterDate. Leaving off the startBeforeDate value makes budgets with any startDate qualify, whereas when leaving off the endAfterDate value will only return budgets whose endDate has not already passed. To get budgets that were active on a specific date, set both values to that day. <b>Spend.</b> If the endAfterDate is supplied, the spend excludes spend that happened after that date. In the case of a daily budget, only the spend for the final day is displayed. See the budgets endpoint for additional details.

Example

// Import classes:
import com.criteo.marketing.ApiClient;
import com.criteo.marketing.ApiException;
import com.criteo.marketing.Configuration;
import com.criteo.marketing.auth.*;
import com.criteo.marketing.models.*;
import com.criteo.marketing.api.SellersV2Api;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.criteo.com/marketing");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    SellersV2Api apiInstance = new SellersV2Api(defaultClient);
    String authorization = "\"Bearer VALID_JWT_TOKEN_BASE64\""; // String | JWT Bearer Token
    String status = "status_example"; // String | Return only budgets with the given status.
    Boolean withBalance = true; // Boolean | Return only budgets with the given status.
    Boolean withSpend = true; // Boolean | Return budgets with any positive spend.
    OffsetDateTime endAfterDate = new OffsetDateTime(); // OffsetDateTime | Return budgets that end after the given date using the `yyyy-MM-DD` format.               If param is not provided, default behavior is to only return budgets that have not yet ended.
    OffsetDateTime startBeforeDate = new OffsetDateTime(); // OffsetDateTime | Return budgets that start on or before the given date using the `yyyy-MM-DD` format.
    Integer campaignId = 56; // Integer | Return only budgets that pay for a given campaign.
    String sellerId = "sellerId_example"; // String | Return only budgets belonging to the given seller.
    String type = "type_example"; // String | Return only budgets with the given budget type.
    Integer advertiserId = 56; // Integer | Return only budgets belonging to the specified advertiser
    try {
      List<SellerBudgetMessage> result = apiInstance.getSellerBudgets(authorization, status, withBalance, withSpend, endAfterDate, startBeforeDate, campaignId, sellerId, type, advertiserId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SellersV2Api#getSellerBudgets");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
authorization String JWT Bearer Token [default to "Bearer VALID_JWT_TOKEN_BASE64"]
status String Return only budgets with the given status. [optional] [enum: Archived, Current, Scheduled]
withBalance Boolean Return only budgets with the given status. [optional]
withSpend Boolean Return budgets with any positive spend. [optional]
endAfterDate OffsetDateTime Return budgets that end after the given date using the `yyyy-MM-DD` format. If param is not provided, default behavior is to only return budgets that have not yet ended. [optional]
startBeforeDate OffsetDateTime Return budgets that start on or before the given date using the `yyyy-MM-DD` format. [optional]
campaignId Integer Return only budgets that pay for a given campaign. [optional]
sellerId String Return only budgets belonging to the given seller. [optional]
type String Return only budgets with the given budget type. [optional]
advertiserId Integer Return only budgets belonging to the specified advertiser [optional]

Return type

List<SellerBudgetMessage>

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml, text/html

HTTP response details

Status code Description Response headers
200 OK -
400 List of errors encountered -
401 Authentication failed. -
403 You do not have access to the requested records -
429 Throttling failure. Maximum sending rate exceeded. -
500 Unknown error. -

getSellerCampaign

SellerCampaignMessage getSellerCampaign(sellerCampaignId, authorization)

Get details for a seller campaign.

Return details for a seller campaign. For example, { &quot;id&quot;: &quot;543210.123456&quot;, &quot;suspendedSince&quot;: &quot;2018-07-30&quot;, &quot;sellerId&quot;: &quot;543210&quot;, &quot;campaignId&quot;: 123456, &quot;bid&quot;: 1.55 } An active seller campaign is one for which the value of <b>suspendedSince</b> is null and the <b>bid</b> is positive. The currency of the bid is the <b>bidCurrency</b> of the associated campaign. Any active seller campaign must also have an active total (capped or uncapped) budget. It may optionally have an active daily budget as well to further limit spending.

Example

// Import classes:
import com.criteo.marketing.ApiClient;
import com.criteo.marketing.ApiException;
import com.criteo.marketing.Configuration;
import com.criteo.marketing.auth.*;
import com.criteo.marketing.models.*;
import com.criteo.marketing.api.SellersV2Api;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.criteo.com/marketing");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    SellersV2Api apiInstance = new SellersV2Api(defaultClient);
    String sellerCampaignId = "sellerCampaignId_example"; // String | Id of the seller campaign.
    String authorization = "\"Bearer VALID_JWT_TOKEN_BASE64\""; // String | JWT Bearer Token
    try {
      SellerCampaignMessage result = apiInstance.getSellerCampaign(sellerCampaignId, authorization);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SellersV2Api#getSellerCampaign");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
sellerCampaignId String Id of the seller campaign.
authorization String JWT Bearer Token [default to "Bearer VALID_JWT_TOKEN_BASE64"]

Return type

SellerCampaignMessage

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, text/html

HTTP response details

Status code Description Response headers
200 OK -
400 List of errors encountered -
401 Authentication failed. -
403 You do not have access to the requested records -
429 Throttling failure. Maximum sending rate exceeded. -
500 Unknown error. -

getSellerCampaigns

List<SellerCampaignMessage> getSellerCampaigns(authorization, sellerStatus, sellerId, campaignId, budgetStatus, advertiserId)

Get a collection of seller campaigns.

Return a collection of seller campaigns filtered by optional filter parameters. If all parameters are omitted the entire collection to which the user has access is returned. Returned sellers must satisfy all supplied filter criteria if multiple parameters are used.

Example

// Import classes:
import com.criteo.marketing.ApiClient;
import com.criteo.marketing.ApiException;
import com.criteo.marketing.Configuration;
import com.criteo.marketing.auth.*;
import com.criteo.marketing.models.*;
import com.criteo.marketing.api.SellersV2Api;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.criteo.com/marketing");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    SellersV2Api apiInstance = new SellersV2Api(defaultClient);
    String authorization = "\"Bearer VALID_JWT_TOKEN_BASE64\""; // String | JWT Bearer Token
    String sellerStatus = "sellerStatus_example"; // String | Return only seller campaigns for sellers with the given status.
    String sellerId = "sellerId_example"; // String | Return only seller campaigns belonging to the given seller.
    Integer campaignId = 56; // Integer | Return only seller campaigns associated with the given campaign.
    String budgetStatus = "budgetStatus_example"; // String | Return only seller campaigns whose budget has the given status.
    Integer advertiserId = 56; // Integer | Return only seller belonging to the specified advertiser
    try {
      List<SellerCampaignMessage> result = apiInstance.getSellerCampaigns(authorization, sellerStatus, sellerId, campaignId, budgetStatus, advertiserId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SellersV2Api#getSellerCampaigns");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
authorization String JWT Bearer Token [default to "Bearer VALID_JWT_TOKEN_BASE64"]
sellerStatus String Return only seller campaigns for sellers with the given status. [optional] [enum: Inactive, Active]
sellerId String Return only seller campaigns belonging to the given seller. [optional]
campaignId Integer Return only seller campaigns associated with the given campaign. [optional]
budgetStatus String Return only seller campaigns whose budget has the given status. [optional] [enum: Archived, Current, Scheduled]
advertiserId Integer Return only seller belonging to the specified advertiser [optional]

Return type

List<SellerCampaignMessage>

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml, text/html

HTTP response details

Status code Description Response headers
200 OK -
400 List of errors encountered -
401 Authentication failed. -
403 You do not have access to the requested records -
429 Throttling failure. Maximum sending rate exceeded. -
500 Unknown error. -

getSellerCampaignsByAdvertiser

List<SellerCampaignMessage> getSellerCampaignsByAdvertiser(advertiserId, authorization)

Get CRP seller-campaigns for a specific advertiser

Example

// Import classes:
import com.criteo.marketing.ApiClient;
import com.criteo.marketing.ApiException;
import com.criteo.marketing.Configuration;
import com.criteo.marketing.auth.*;
import com.criteo.marketing.models.*;
import com.criteo.marketing.api.SellersV2Api;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.criteo.com/marketing");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    SellersV2Api apiInstance = new SellersV2Api(defaultClient);
    Integer advertiserId = 56; // Integer | 
    String authorization = "\"Bearer VALID_JWT_TOKEN_BASE64\""; // String | JWT Bearer Token
    try {
      List<SellerCampaignMessage> result = apiInstance.getSellerCampaignsByAdvertiser(advertiserId, authorization);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SellersV2Api#getSellerCampaignsByAdvertiser");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
advertiserId Integer
authorization String JWT Bearer Token [default to "Bearer VALID_JWT_TOKEN_BASE64"]

Return type

List<SellerCampaignMessage>

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml, text/html

HTTP response details

Status code Description Response headers
200 OK -
401 Authentication failed. -
403 You do not have access to the requested records -
429 Throttling failure. Maximum sending rate exceeded. -
500 Unknown error. -

getSellerCampaignsBySeller

List<SellerCampaignMessage> getSellerCampaignsBySeller(sellerId, authorization, sellerStatus, campaignId, budgetStatus)

Get a collection of seller campaigns for this seller.

Return a collection of seller campaigns for this seller filtered by optional filter parameters. If all parameters are omitted the entire collection to which the user has access is returned. Returned sellers must satisfy all supplied filter criteria if multiple parameters are used. See the seller campaigns endpoint for additional details.

Example

// Import classes:
import com.criteo.marketing.ApiClient;
import com.criteo.marketing.ApiException;
import com.criteo.marketing.Configuration;
import com.criteo.marketing.auth.*;
import com.criteo.marketing.models.*;
import com.criteo.marketing.api.SellersV2Api;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.criteo.com/marketing");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    SellersV2Api apiInstance = new SellersV2Api(defaultClient);
    String sellerId = "sellerId_example"; // String | Return only seller campaigns belonging to the given seller.
    String authorization = "\"Bearer VALID_JWT_TOKEN_BASE64\""; // String | JWT Bearer Token
    String sellerStatus = "sellerStatus_example"; // String | Return only seller campaigns for sellers with the given status.
    Integer campaignId = 56; // Integer | Return only seller campaigns associated with the given campaign.
    String budgetStatus = "budgetStatus_example"; // String | Return only seller campaigns whose budget has the given status.
    try {
      List<SellerCampaignMessage> result = apiInstance.getSellerCampaignsBySeller(sellerId, authorization, sellerStatus, campaignId, budgetStatus);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SellersV2Api#getSellerCampaignsBySeller");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
sellerId String Return only seller campaigns belonging to the given seller.
authorization String JWT Bearer Token [default to "Bearer VALID_JWT_TOKEN_BASE64"]
sellerStatus String Return only seller campaigns for sellers with the given status. [optional] [enum: Inactive, Active]
campaignId Integer Return only seller campaigns associated with the given campaign. [optional]
budgetStatus String Return only seller campaigns whose budget has the given status. [optional] [enum: Archived, Current, Scheduled]

Return type

List<SellerCampaignMessage>

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml, text/html

HTTP response details

Status code Description Response headers
200 OK -
400 List of errors encountered -
401 Authentication failed. -
403 You do not have access to the requested records -
429 Throttling failure. Maximum sending rate exceeded. -
500 Unknown error. -

getSellers

List<SellerBase> getSellers(authorization, sellerStatus, withProducts, withBudgetStatus, sellerName, advertiserId, campaignId)

Get a collection of sellers.

Return a collection of sellers filtered by optional filter parameters. If all parameters are omitted the entire collection to which the user has access is returned. Returned sellers must satisfy all supplied filter criteria if multiple parameters are used.

Example

// Import classes:
import com.criteo.marketing.ApiClient;
import com.criteo.marketing.ApiException;
import com.criteo.marketing.Configuration;
import com.criteo.marketing.auth.*;
import com.criteo.marketing.models.*;
import com.criteo.marketing.api.SellersV2Api;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.criteo.com/marketing");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    SellersV2Api apiInstance = new SellersV2Api(defaultClient);
    String authorization = "\"Bearer VALID_JWT_TOKEN_BASE64\""; // String | JWT Bearer Token
    String sellerStatus = "sellerStatus_example"; // String | Return only sellers with specific status.
    Boolean withProducts = true; // Boolean | Return only sellers with or without products in catalog.
    String withBudgetStatus = "withBudgetStatus_example"; // String | Return only sellers with specific budget status.
    String sellerName = "sellerName_example"; // String | Return only sellers with the matching name.
    Integer advertiserId = 56; // Integer | Return only sellers belonging to the specified advertiser
    Integer campaignId = 56; // Integer | Return only sellers belonging to the specified campaign
    try {
      List<SellerBase> result = apiInstance.getSellers(authorization, sellerStatus, withProducts, withBudgetStatus, sellerName, advertiserId, campaignId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SellersV2Api#getSellers");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
authorization String JWT Bearer Token [default to "Bearer VALID_JWT_TOKEN_BASE64"]
sellerStatus String Return only sellers with specific status. [optional] [enum: Inactive, Active]
withProducts Boolean Return only sellers with or without products in catalog. [optional]
withBudgetStatus String Return only sellers with specific budget status. [optional] [enum: Archived, Current, Scheduled]
sellerName String Return only sellers with the matching name. [optional]
advertiserId Integer Return only sellers belonging to the specified advertiser [optional]
campaignId Integer Return only sellers belonging to the specified campaign [optional]

Return type

List<SellerBase>

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml, text/html

HTTP response details

Status code Description Response headers
200 OK -
400 List of errors encountered -
401 Authentication failed. -
403 You do not have access to the requested records -
429 Throttling failure. Maximum sending rate exceeded. -
500 Unknown error. -

updateSellerBudget

SellerBudgetMessage updateSellerBudget(budgetId, authorization, message)

Modify a single budget.

Modify an existing active budget to change its limitations or status. All three types of budgets can be modified. See the additional restrictions listed in the PATCH budgets endpoint.

Example

// Import classes:
import com.criteo.marketing.ApiClient;
import com.criteo.marketing.ApiException;
import com.criteo.marketing.Configuration;
import com.criteo.marketing.auth.*;
import com.criteo.marketing.models.*;
import com.criteo.marketing.api.SellersV2Api;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.criteo.com/marketing");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    SellersV2Api apiInstance = new SellersV2Api(defaultClient);
    Long budgetId = 56L; // Long | 
    String authorization = "\"Bearer VALID_JWT_TOKEN_BASE64\""; // String | JWT Bearer Token
    UpdateSellerBudgetMessageBase message = new UpdateSellerBudgetMessageBase(); // UpdateSellerBudgetMessageBase | 
    try {
      SellerBudgetMessage result = apiInstance.updateSellerBudget(budgetId, authorization, message);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SellersV2Api#updateSellerBudget");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
budgetId Long
authorization String JWT Bearer Token [default to "Bearer VALID_JWT_TOKEN_BASE64"]
message UpdateSellerBudgetMessageBase

Return type

SellerBudgetMessage

Authorization

Authorization

HTTP request headers

  • Content-Type: application/json, text/json, application/x-www-form-urlencoded, text/html
  • Accept: application/json, text/json, text/html

HTTP response details

Status code Description Response headers
200 OK -
401 Authentication failed. -
403 You do not have access to the requested records -
429 Throttling failure. Maximum sending rate exceeded. -
500 Unknown error. -

updateSellerBudgets

List<SellerBudgetMessage> updateSellerBudgets(authorization, updateSellerBudgets)

Modify a collection of budgets.

Modify one or more existing active budgets to change their limitations or status. All three types of budgets can be modified. The following constraints apply when modifying an existing budget. • <b>campaignIds</b>: a non-empty subset of the original campaign ids MAY be supplied<br /> • <b>amount</b>: an amount MAY be supplied only if the type is not Uncapped and if supplied it MUST be non-negative<br /> • <b>startDate</b>: a future start date MAY be supplied for budgets that have not yet started<br /> • <b>endDate</b>: an end date MAY be supplied and if supplied MUST be a future date greater than the start date<br /> Other attributes MUST NOT be supplied. Adding new campaigns to a budget is not allowed. In addition, reducing the amount for a Capped budget to a value less than the current spend not allowed.

Example

// Import classes:
import com.criteo.marketing.ApiClient;
import com.criteo.marketing.ApiException;
import com.criteo.marketing.Configuration;
import com.criteo.marketing.auth.*;
import com.criteo.marketing.models.*;
import com.criteo.marketing.api.SellersV2Api;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.criteo.com/marketing");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    SellersV2Api apiInstance = new SellersV2Api(defaultClient);
    String authorization = "\"Bearer VALID_JWT_TOKEN_BASE64\""; // String | JWT Bearer Token
    List<UpdateSellerBudgetMessage> updateSellerBudgets = Arrays.asList(); // List<UpdateSellerBudgetMessage> | 
    try {
      List<SellerBudgetMessage> result = apiInstance.updateSellerBudgets(authorization, updateSellerBudgets);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SellersV2Api#updateSellerBudgets");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
authorization String JWT Bearer Token [default to "Bearer VALID_JWT_TOKEN_BASE64"]
updateSellerBudgets List<UpdateSellerBudgetMessage>

Return type

List<SellerBudgetMessage>

Authorization

Authorization

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, text/html
  • Accept: application/json, text/json, application/xml, text/xml, text/html

HTTP response details

Status code Description Response headers
200 OK -
401 Authentication failed. -
403 You do not have access to the requested records -
429 Throttling failure. Maximum sending rate exceeded. -
500 Unknown error. -

updateSellerCampaign

SellerCampaignMessage updateSellerCampaign(sellerCampaignId, bid, authorization)

Update an existing seller campaign.

Patching a seller campaign allows the bid to be modified. The bid must be a non-negative value. Setting the bid to zero will make a seller campaign inactive. The currency used for bids will be the default currency of the campaign.

Example

// Import classes:
import com.criteo.marketing.ApiClient;
import com.criteo.marketing.ApiException;
import com.criteo.marketing.Configuration;
import com.criteo.marketing.auth.*;
import com.criteo.marketing.models.*;
import com.criteo.marketing.api.SellersV2Api;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.criteo.com/marketing");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    SellersV2Api apiInstance = new SellersV2Api(defaultClient);
    String sellerCampaignId = "sellerCampaignId_example"; // String | Id of the existing seller campaign to update
    Double bid = 3.4D; // Double | The new bid for the seller campaign.
    String authorization = "\"Bearer VALID_JWT_TOKEN_BASE64\""; // String | JWT Bearer Token
    try {
      SellerCampaignMessage result = apiInstance.updateSellerCampaign(sellerCampaignId, bid, authorization);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SellersV2Api#updateSellerCampaign");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
sellerCampaignId String Id of the existing seller campaign to update
bid Double The new bid for the seller campaign.
authorization String JWT Bearer Token [default to "Bearer VALID_JWT_TOKEN_BASE64"]

Return type

SellerCampaignMessage

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, text/html

HTTP response details

Status code Description Response headers
200 OK -
400 List of errors encountered -
401 Authentication failed. -
403 You do not have access to the requested records -
429 Throttling failure. Maximum sending rate exceeded. -
500 Unknown error. -

updateSellerCampaigns

List<SellerCampaignMessage> updateSellerCampaigns(authorization, campaignMessages)

Update a collection of seller campaigns.

Patching a collection of seller campaigns allows their bids to be modified. Each bid must be a non-negative value. Setting the bid to zero will make a seller campaign inactive. The currency used for bids will be the default currency of the campaign.

Example

// Import classes:
import com.criteo.marketing.ApiClient;
import com.criteo.marketing.ApiException;
import com.criteo.marketing.Configuration;
import com.criteo.marketing.auth.*;
import com.criteo.marketing.models.*;
import com.criteo.marketing.api.SellersV2Api;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.criteo.com/marketing");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    SellersV2Api apiInstance = new SellersV2Api(defaultClient);
    String authorization = "\"Bearer VALID_JWT_TOKEN_BASE64\""; // String | JWT Bearer Token
    List<SellerCampaignUpdate> campaignMessages = Arrays.asList(); // List<SellerCampaignUpdate> | 
    try {
      List<SellerCampaignMessage> result = apiInstance.updateSellerCampaigns(authorization, campaignMessages);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SellersV2Api#updateSellerCampaigns");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
authorization String JWT Bearer Token [default to "Bearer VALID_JWT_TOKEN_BASE64"]
campaignMessages List<SellerCampaignUpdate>

Return type

List<SellerCampaignMessage>

Authorization

Authorization

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, text/html
  • Accept: application/json, text/json, application/xml, text/xml, text/html

HTTP response details

Status code Description Response headers
200 OK -
400 List of errors encountered -
401 Authentication failed. -
403 You do not have access to the requested records -
429 Throttling failure. Maximum sending rate exceeded. -
500 Unknown error. -