v1

latestOpenAPI 3.0.02026-07-2466275257.1 KB

productCampaign

Retrieve list of all product campaigns

This endpoint shows all product campaigns with options to filter and sort them. Search by campaign name, team, approval status, and more. Results are shown in pages to make them easier to view and manage.

get/v3/product-campaigns

Query parameters

pageTokenstring

Use the pagination token to retrieve the next page of results.

pageSizestring int64

Define the number of campaigns you are requesting per page.

sortOptionsstring[]

Specifies the order in which the response should be sorted:

SORT_OPTION_ASC: Sorts results in ascending order, such as sorting by "updated time" from oldest to newest.
SORT_OPTION_DESC: Sorts results in descending order, such as sorting by "updated time" from newest to oldest.

namestring

Filter campaigns using the specified campaign name.

placementIdstring

Filter campaigns using the specified placement ID.

teamIdstring

Filter campaigns using the specified team ID.

approvalState'APPROVAL_STATE_PENDING' | 'APPROVAL_STATE_APPROVED' | 'APPROVAL_STATE_REJECTED'

Filter campaigns using the specified approval state.

campaignState'CAMPAIGN_STATE_ACTIVE' | 'CAMPAIGN_STATE_PAUSED' | 'CAMPAIGN_STATE_DRAFT' | 'CAMPAIGN_STATE_ARCHIVED'

Filter campaigns using the specific campaign active state.

catalogIdsstring[]

Filter campaigns using one or more catalog IDs. You can specify multiple catalog IDs in the request.

managedOnlyboolean

Filter campaigns to include only those managed by retailers, such as fixed tenancy campaigns.

requestTeamIdstring

The ID of the team requesting campaigns. Retailers can use their team ID to list campaigns across multiple teams, while advertisers can use their own team ID.

walletIdstring

Filter campaigns by a specific wallet ID.

Response

A list of campaigns and a pagination token.

nextPageTokenstring

This token allows you to access the next page of results. Use it in your next request to continue retrieving data. If absent, there are no more pages.

totalCountstring int64

Indicates the total number of campaign records that match your criteria, regardless of pagination. It gives you the overall count of records available based on your query.

Example response

{
  "productCampaigns": [
    {
      "advertisedProducts": {
        "productsByKey": [
          {
            "catalogId": "catalog_001",
            "productCode": "PROD123456",
            "sellerId": "seller_78910"
          }
        ]
      },
      "targeting": {
        "searchTerms": [
          {
            "phrase": "example search term",
            "collectionName": "default_collection",
            "suggested": true,
            "excludedProducts": [
              {
                "catalogId": "catalog_001",
                "productCode": "PROD123456",
                "sellerId": "seller_78910"
              }
            ],
            "maxBid": "100.00",
            "treatAsCustom": true
          }
        ],
        "crossSell": {
          "targetProductsByKey": [
            {
              "catalogId": "catalog_001",
              "productCode": "PROD123456",
              "sellerId": "seller_78910"
            }
          ]
        },
        "upsell": {
          "targetProductsByKey": [
            {
              "catalogId": "catalog_001",
              "productCode": "PROD123456",
              "sellerId": "seller_78910"
            }
          ]
        },
        "excludeFilters": [
          {
            "catalogId": "catalog_12345",
            "filter": "filter_value_abc"
          }
        ],
        "includeFilters": [
          {
            "catalogId": "catalog_12345",
            "filter": "filter_value_abc"
          }
        ]
      },
      "strategy": {
        "auction": {
          "maxBid": "$100.00",
          "spendLimit": {
            "daily": "$50.00",
            "total": "$1000.00"
          }
        },
        "fixedTenancy": {
          "cost": "$99.99",
          "positions": [
            1,
            2,
            3
          ],
          "catalogCosts": [
            {
              "catalogId": "catalog_123456",
              "catalogCostPercentage": 0.25
            }
          ]
        }
      },
      "fixedCosts": {
        "dataCost": "$100.00",
        "creativeCost": "$200.00",
        "otherCost": "$50.00"
      },
      "customFields": [
        {
          "customFieldId": "cfid_12345",
          "content": "This is a custom field content."
        }
      ],
      "customQuestions": [
        {
          "customQuestionId": "cqid_67890",
          "answers": [
            "Answer 1",
            "Answer 2",
            "Answer 3"
          ]
        }
      ]
    }
  ]
}