> For the complete documentation index, see [llms.txt](https://help.citrusad.com/retail-media-interface/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.citrusad.com/retail-media-interface/partner/ja/campaign-management-api/campaign/listcampaigns-1.md).

# すべてのキャンペーンのリストの取得

## Retrieve list of all campaigns

> This endpoint retrieves a list of campaigns based on specified filters and parameters such as campaign name, campaign type, placement ID, team ID, approval state, and more. A date range (from and to) can be provided to narrow results based on the updateTime of the campaign. Pagination and sorting are supported to manage large datasets efficiently.

```json
{"openapi":"3.0.0","info":{"title":"Citrus Campaign APIs","version":"v3"},"tags":[],"servers":[{"url":"https://campaign.<env>.citrusad.com"}],"security":[{"TokenSecurity":[]}],"components":{"securitySchemes":{"TokenSecurity":{"description":"For accessing the API a valid JWT jwt must be passed in all queries in the 'Authorization' header. The following syntax must be used in the 'Authorization' header. (Bearer xxx.yyy.zzz)","in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"v3ListCampaignsRequest":{"properties":{"filters":{"$ref":"#/components/schemas/v3ListCampaignFilters"}},"title":"List campaigns of all type","type":"object"},"v3ListCampaignFilters":{"properties":{"approvalState":{"description":"Filter campaigns by the specified approval state. You can use APPROVAL_STATE_PENDING, APPROVAL_STATE_APPROVED, or APPROVAL_STATE_REJECTED. You can include one or more approval states.","type":"string"},"campaignState":{"description":"Filter campaigns by the specified campaign state. You can use CAMPAIGN_STATE_ACTIVE, CAMPAIGN_STATE_PAUSED, CAMPAIGN_STATE_DRAFT, or CAMPAIGN_STATE_ARCHIVED. You can include one or more campaign states.","type":"string"},"campaignType":{"description":"List campaigns by different campaign file types, such as BannerX, Product, Banner and Brand page.","type":"string"},"catalogIds":{"description":"Filter campaigns by one or more catalog IDs. Multiple catalog IDs can be specified.","items":{"type":"string"},"type":"array"},"fromDate":{"description":"Specifies the start timestamp for retrieving campaigns. Provide the time in ISO-8601 format. If fromDate is specified, toDate must also be included.","format":"date-time","type":"string"},"ids":{"description":"Filter campaigns using specified campaign IDs. Up to 1000 campaign IDs can be included in the request, separated by commas.","items":{"type":"string"},"type":"array"},"managedOnly":{"description":"Filter campaigns to only include those that are retailer-managed, such as fixed tenancy.","type":"boolean"},"name":{"description":"Filter campaigns by the specified name.","type":"string"},"pageSize":{"description":"The pageSize specifies the number of campaigns to retrieve per page. Only positive integers up to 1000 are allowed. If a value greater than 1000 is provided, an error will be returned.","format":"int64","type":"string"},"pageToken":{"description":"Pagination token to retrieve the next page of results.","type":"string"},"placementId":{"description":"Filter campaigns using specified placement IDs. You can include up to 50 placement IDs in your request.","type":"string"},"requestTeamId":{"description":"The ID of the team requesting campaigns. Retailers use their team ID to list campaigns across multiple teams, while advertisers use their own team ID.","type":"string"},"servingState":{"description":"Filter campaigns by serving state. You can use SERVING_STATE_SCHEDULED or SERVING_STATE_COMPLETED. You can include one or more serving states separated by commas.","type":"string"},"sortOptions":{"$ref":"#/components/schemas/v3ListCampaignFiltersSortOption"},"teamId":{"description":"Filter campaigns by the specified team ID.","type":"string"},"toDate":{"description":"Specifies the end timestamp for retrieving campaigns. Provide the time in ISO-8601 format. If toDate is specified, fromDate must also be included.","format":"date-time","type":"string"},"walletId":{"description":"Filter campaigns using specified wallet IDs. You can include up to 50 wallet IDs in your request.","type":"string"}},"type":"object"},"v3ListCampaignFiltersSortOption":{"properties":{"key":{"$ref":"#/components/schemas/v3ListCampaignFiltersSortOptionSortOptionKey"},"lastValue":{"description":"The lastValue is used to retrieve the subsequent set of results on the next page. It must not be included in the request body.","type":"string"},"order":{"$ref":"#/components/schemas/v3ListCampaignFiltersSortOptionSortOptionOrder"}},"type":"object"},"v3ListCampaignFiltersSortOptionSortOptionKey":{"enum":["SORT_OPTION_KEY_UPDATE_TIME","SORT_OPTION_KEY_NAME","SORT_OPTION_KEY_END_TIME","SORT_OPTION_KEY_APPROVAL_STATE","SORT_OPTION_KEY_CAMPAIGN_STATE","SORT_OPTION_KEY_START_TIME"],"type":"string"},"v3ListCampaignFiltersSortOptionSortOptionOrder":{"enum":["SORT_OPTION_ORDER_ASC","SORT_OPTION_ORDER_DESC"],"type":"string"},"v3ListCampaignsResponse":{"properties":{"campaigns":{"items":{"$ref":"#/components/schemas/v3Campaign"},"type":"array"},"nextPageToken":{"description":"The page token used to request the next page in pagination. Include it as pageToken in the request.","type":"string"},"totalCount":{"description":"Displays the total number of campaigns that meet the specified criteria.","format":"int64","type":"string"}},"type":"object"},"v3Campaign":{"properties":{"advertisedProducts":{"$ref":"#/components/schemas/campaignv3AdvertisedProducts"},"approval":{"$ref":"#/components/schemas/campaignv3Approval"},"bannerConfig":{"$ref":"#/components/schemas/v3BannerConfig"},"bannerXConfig":{"$ref":"#/components/schemas/v3BannerXConfig"},"brandPageConfig":{"$ref":"#/components/schemas/v3BrandPageConfig"},"campaignState":{"$ref":"#/components/schemas/campaignv3CampaignState"},"catalogIds":{"description":"The unique identifier of the retailer's catalog.","items":{"type":"string"},"maxItems":5,"minItems":1,"type":"array","uniqueItems":true},"customFields":{"items":{"$ref":"#/components/schemas/campaignv3CustomField"},"maxItems":5,"type":"array","uniqueItems":true},"customQuestions":{"description":"Used for integrations utilising custom targeting.","items":{"$ref":"#/components/schemas/campaignv3CustomQuestion"},"maxItems":5,"type":"array"},"endTime":{"description":"When the campaign ends as a precise ISO-8601 timestamp. If removed then the campaign will be treated as 'ALWAYS ON'.","format":"date-time","type":"string"},"fixedCosts":{"$ref":"#/components/schemas/campaignv3FixedCosts"},"id":{"description":"The unique identifier of the campaign.","readOnly":true,"type":"string"},"managerTeamId":{"description":"The retailer manager teamId of the campaign. Only utilised in fixed tenancy campaigns.","type":"string"},"name":{"description":"The name of the campaign.","type":"string"},"namespaceId":{"description":"The unique identifier of the namespace.","type":"string"},"placementId":{"description":"The unique identifier of the campaign's placement.","type":"string"},"sellerId":{"description":"The sellerId of the campaign. Defaults to empty string if null.","type":"string"},"servingState":{"$ref":"#/components/schemas/v3ServingState"},"settings":{"$ref":"#/components/schemas/v3CampaignSettings"},"startTime":{"description":"When the campaign starts as a precise ISO-8601 timestamp.","format":"date-time","type":"string"},"strategy":{"$ref":"#/components/schemas/campaignv3Strategy"},"targeting":{"$ref":"#/components/schemas/campaignv3Targeting"},"teamId":{"description":"The unique identifier of the campaign's team.","type":"string"},"templateId":{"description":"The unique identifier of the campaign template.","type":"string"},"updateTime":{"description":"The last time the entity was updated.","format":"date-time","readOnly":true,"type":"string"},"walletId":{"description":"The unique identifier of the wallet to be charged for the campaign.","type":"string"}},"required":["name","namespaceId","campaignState","teamId","walletId","placementId","catalogIds","strategy"],"type":"object"},"campaignv3AdvertisedProducts":{"properties":{"productGroupList":{"description":"The list of product group ids from Epsilon Digital","items":{"type":"string"},"type":"array"},"productsByAttributes":{"$ref":"#/components/schemas/campaignv3ProductsByAttributes"},"productsByKey":{"items":{"$ref":"#/components/schemas/campaignv3CatalogProductSeller"},"maxItems":250,"type":"array"}},"type":"object"},"campaignv3ProductsByAttributes":{"properties":{"priceRange":{"$ref":"#/components/schemas/campaignv3PriceRange"},"tags":{"description":"Unique product attributes as defined in the catalog.","items":{"type":"string"},"maxItems":5,"minItems":1,"type":"array","uniqueItems":true}},"type":"object"},"campaignv3PriceRange":{"properties":{"max":{"description":"The maximum value of the price range.","type":"string"},"min":{"description":"The minimum value of the price range.","type":"string"}},"type":"object"},"campaignv3CatalogProductSeller":{"properties":{"catalogId":{"description":"The unique identifier of the retailer's catalog.","type":"string"},"productCode":{"description":"The product code within the catalog.","type":"string"},"sellerId":{"description":"The seller ID for the product. Defaults to an empty string.","type":"string"}},"required":["catalogId","productCode"],"type":"object"},"campaignv3Approval":{"properties":{"rejectionReason":{"description":"The reason a campaign has been rejected. Mandatory field if status is APPROVAL_STATE_REJECTED","type":"string"},"state":{"$ref":"#/components/schemas/campaignv3ApprovalApprovalState"}},"type":"object"},"campaignv3ApprovalApprovalState":{"enum":["APPROVAL_STATE_PENDING","APPROVAL_STATE_APPROVED","APPROVAL_STATE_REJECTED"],"type":"string"},"v3BannerConfig":{"properties":{"contentStandardId":{"description":"The unique identifier of the content standard.","type":"string"},"slotsConfiguration":{"description":"The unique identifier of the slots configuration.","items":{"$ref":"#/components/schemas/v3SlotsConfiguration"},"type":"array"}},"required":["contentStandardId","slotsConfiguration"],"type":"object"},"v3SlotsConfiguration":{"properties":{"altText":{"description":"Alternative text for the artwork image, providing a description for accessibility. Example: 'Promotional banner for summer sale'","type":"string"},"artworkImageId":{"description":"The identifier for the image used as artwork in the slot. Example: 'image_1234'","type":"string"},"link":{"description":"The URL link associated with the slot, directing the user to a target page when clicked. Example: 'https://www.example.com/promo'","type":"string"},"slotId":{"description":"The unique identifier for the slot in the configuration. Example: 'homepage_banner_slot_1'","type":"string"},"text":{"description":"The display text for the slot, providing additional information or a message. Example: 'Get 20% off your first purchase!'","type":"string"},"trackingTagProvider":{"description":"List of tracking tags from the provider, required for tracking interactions with the slot. Example: '[ { provider: 'Google Analytics', tag: 'promo_click' }, { provider: 'Adobe Analytics', tag: 'banner_view' } ]'","items":{"$ref":"#/components/schemas/v3TrackingTag"},"type":"array"}},"required":["slotId","artworkImageId","altText","text"],"type":"object"},"v3TrackingTag":{"properties":{"content":{"description":"The content of the tracking tag.","type":"string"},"provider":{"$ref":"#/components/schemas/TrackingTagTrackingTagProvider"}},"type":"object"},"TrackingTagTrackingTagProvider":{"enum":["TRACKING_TAG_PROVIDER_DV","TRACKING_TAG_PROVIDER_DCM_CLICK","TRACKING_TAG_PROVIDER_DCM_IMPRESSION","TRACKING_TAG_PROVIDER_MOAT","TRACKING_TAG_PROVIDER_IAS","TRACKING_TAG_PROVIDER_GTM360","TRACKING_TAG_PROVIDER_SIZMEK","TRACKING_TAG_PROVIDER_ADFORM_CLICK","TRACKING_TAG_PROVIDER_ADFORM_IMPRESSION","TRACKING_TAG_PROVIDER_DV_IMAGE"],"type":"string"},"v3BannerXConfig":{"properties":{"additionalFields":{"description":"BannerX AdditionalFields","items":{"$ref":"#/components/schemas/v3AdditionalFields"},"type":"array"},"backgroundColourHex":{"description":"The background color of the banner in hex format.","type":"string"},"backgroundImageId":{"description":"The unique identifier of the background image.","type":"string"},"backgroundImagePosition":{"$ref":"#/components/schemas/v3BannerXConfigBannerXBackgroundImagePosition"},"bannerText":{"description":"The main text of the banner.","type":"string"},"bannerTextColourHex":{"description":"The color of the banner text in hex format.","type":"string"},"companionProducts":{"description":"Products to be rendered in BannerX","items":{"$ref":"#/components/schemas/campaignv3CatalogProductSeller"},"type":"array"},"contentStandardId":{"description":"The unique identifier of the content standard.","type":"string"},"ctaFlag":{"description":"Flag indicating if the banner has a call-to-action.","type":"boolean"},"ctaLink":{"description":"The URL for the call-to-action link.","type":"string"},"ctaText":{"description":"The call-to-action text on the banner.","type":"string"},"ctaTextAccessibility":{"description":"The call-to-action text for accessibility purposes.","type":"string"},"headingText":{"description":"The heading text for the banner.","type":"string"},"heroImageAltText":{"description":"The alternate text for the hero image.","type":"string"},"heroImageId":{"description":"The unique identifier for the hero image.","type":"string"},"heroMode":{"$ref":"#/components/schemas/v3BannerXConfigBannerXHeroImageMode"},"secondaryBackgroundImageId":{"description":"The unique identifier for the secondary background image.","type":"string"},"secondaryBackgroundImagePosition":{"$ref":"#/components/schemas/v3BannerXConfigBannerXBackgroundImagePosition"},"secondaryHeroImageAltText":{"description":"The alt text for the secondary hero image.","type":"string"},"secondaryHeroImageId":{"description":"The unique identifier for the secondary hero image.","type":"string"},"secondaryHeroMode":{"$ref":"#/components/schemas/v3BannerXConfigBannerXHeroImageMode"},"slotId":{"description":"The unique identifier of the slot.","type":"string"},"slotType":{"$ref":"#/components/schemas/BannerXConfigBannerXSlotType"},"trackingTagProvider":{"description":"BannerX TrackingTagProvider","items":{"$ref":"#/components/schemas/v3TrackingTag"},"type":"array"},"videoConfigs":{"description":"BannerX VideoConfig","items":{"$ref":"#/components/schemas/BannerXConfigVideoConfig"},"type":"array"}},"required":["contentStandardId","slotId","slotType"],"type":"object"},"v3AdditionalFields":{"properties":{"id":{"description":"The unique identifier for the item.","type":"string"},"value":{"description":"The value associated with the item.","type":"string"}},"type":"object"},"v3BannerXConfigBannerXBackgroundImagePosition":{"enum":["BANNER_X_BACKGROUND_IMAGE_POSITION_REPEATING","BANNER_X_BACKGROUND_IMAGE_POSITION_LEFTALIGNED","BANNER_X_BACKGROUND_IMAGE_POSITION_RIGHTALIGNED","BANNER_X_BACKGROUND_IMAGE_POSITION_TOPALIGNED","BANNER_X_BACKGROUND_IMAGE_POSITION_BOTTOMALIGNED","BANNER_X_BACKGROUND_IMAGE_POSITION_FILL"],"type":"string"},"v3BannerXConfigBannerXHeroImageMode":{"enum":["BANNER_X_HERO_IMAGE_MODE_BLOCK","BANNER_X_HERO_IMAGE_MODE_LANDSCAPE","BANNER_X_HERO_IMAGE_MODE_PORTRAIT"],"type":"string"},"BannerXConfigBannerXSlotType":{"enum":["BANNER_X_SLOT_TYPE_BANNER","BANNER_X_SLOT_TYPE_SINGLE_TILE","BANNER_X_SLOT_TYPE_DOUBLE_TILE"],"type":"string"},"BannerXConfigVideoConfig":{"properties":{"fileId":{"description":"The unique identifier for the video file. Id is generated and provided by Epsilon upload file endpoint","type":"string"},"id":{"description":"The unique identifier of the video configuration from the corresponding content standard","type":"string"}},"required":["id","fileId"],"type":"object"},"v3BrandPageConfig":{"properties":{"brandPageTemplateId":{"description":"The template ID used for this brand page","type":"string"},"content":{"description":"Array of content modules for the brand page","items":{"$ref":"#/components/schemas/BrandPageConfigBrandPageContent"},"type":"array"},"contentStandardId":{"description":"The unique identifier of the content standard.","type":"string"},"enabledAdTypes":{"description":"EnabledAdTypes","items":{"$ref":"#/components/schemas/BrandPageConfigEnabledAdTypes"},"type":"array"},"featureVersion":{"$ref":"#/components/schemas/BrandPageConfigBrandPageFeatureVersion"},"name":{"description":"Name","type":"string"},"pageContentText":{"description":"pageContentText","type":"string"},"pageHeadingText":{"description":"pageHeadingText","type":"string"},"url":{"description":"URL of the retailer website","type":"string"},"urlPrefix":{"description":"URL path/segment of the retailer website that contains their brand pages","type":"string"},"urlSuffix":{"description":"Final URL path/segment of the retailer website that will render the brand page data","type":"string"}},"required":["name","contentStandardId"],"type":"object"},"BrandPageConfigBrandPageContent":{"properties":{"brandPageModuleTemplateId":{"description":"The template identifier for the brand page module.","type":"string"},"contentType":{"$ref":"#/components/schemas/BrandPageConfigBrandPageContentType"},"filterMenu":{"$ref":"#/components/schemas/BrandPageConfigFilterMenuContent"},"hero":{"$ref":"#/components/schemas/BrandPageConfigHeroContent"},"id":{"description":"The unique identifier for the brand page content.","type":"string"},"image":{"$ref":"#/components/schemas/BrandPageConfigImageContent"},"imageGallery":{"$ref":"#/components/schemas/BrandPageConfigImageGalleryContent"},"order":{"description":"The display order of the content.","format":"int32","type":"integer"},"productGrid":{"$ref":"#/components/schemas/BrandPageConfigProductGridContent"},"splitLayout":{"$ref":"#/components/schemas/BrandPageConfigSplitLayoutContent"},"text":{"$ref":"#/components/schemas/BrandPageConfigTextContent"}},"type":"object"},"BrandPageConfigBrandPageContentType":{"enum":["BRAND_PAGE_CONTENT_TYPE_HERO","BRAND_PAGE_CONTENT_TYPE_PRODUCT_GRID","BRAND_PAGE_CONTENT_TYPE_TEXT","BRAND_PAGE_CONTENT_TYPE_IMAGE","BRAND_PAGE_CONTENT_TYPE_SPLIT_LAYOUT","BRAND_PAGE_CONTENT_TYPE_IMAGE_GALLERY","BRAND_PAGE_CONTENT_TYPE_FILTER_MENU"],"type":"string"},"BrandPageConfigFilterMenuContent":{"properties":{"items":{"items":{"$ref":"#/components/schemas/FilterMenuContentFilterMenuItem"},"type":"array"}},"type":"object"},"FilterMenuContentFilterMenuItem":{"properties":{"label":{"type":"string"},"value":{"type":"string"}},"type":"object"},"BrandPageConfigHeroContent":{"properties":{"ctaLink":{"description":"The URL for the call-to-action button.","type":"string"},"ctaText":{"description":"The call-to-action button text.","type":"string"},"headline":{"description":"The main headline text for the hero section.","type":"string"},"mediaAlt":{"description":"The alternative text for the hero media.","type":"string"},"mediaType":{"description":"The type of media (image or video).","type":"string"},"mediaUrl":{"description":"The URL of the hero media asset.","type":"string"},"overlayBackground":{"$ref":"#/components/schemas/HeroContentHeroOverlayBackground"},"overlayEnabled":{"description":"Indicates whether an overlay is enabled on the hero media.","type":"boolean"},"subheadline":{"description":"The subheadline text for the hero section.","type":"string"}},"type":"object"},"HeroContentHeroOverlayBackground":{"enum":["HERO_OVERLAY_BACKGROUND_GRADIENT","HERO_OVERLAY_BACKGROUND_SOLID"],"type":"string"},"BrandPageConfigImageContent":{"properties":{"additionalTextLines":{"items":{"$ref":"#/components/schemas/TextContentTextContentLine"},"type":"array"},"alt":{"description":"The alternative text for the image.","type":"string"},"caption":{"description":"The caption text for the image.","type":"string"},"linkType":{"$ref":"#/components/schemas/ImageContentImageLinkType"},"linkUrl":{"description":"The URL the image links to.","type":"string"},"product":{"$ref":"#/components/schemas/campaignv3CatalogProductSeller"},"url":{"description":"The URL of the image.","type":"string"}},"type":"object"},"TextContentTextContentLine":{"properties":{"name":{"type":"string"},"text":{"type":"string"},"url":{"type":"string"}},"type":"object"},"ImageContentImageLinkType":{"enum":["IMAGE_LINK_TYPE_IMAGE","IMAGE_LINK_TYPE_PRODUCT","IMAGE_LINK_TYPE_URL"],"type":"string"},"BrandPageConfigImageGalleryContent":{"properties":{"cta":{"$ref":"#/components/schemas/BrandPageConfigCallToAction"},"images":{"description":"The collection of images in the gallery.","items":{"$ref":"#/components/schemas/BrandPageConfigImageContent"},"type":"array"},"sectionDescription":{"type":"string"},"sectionTitle":{"description":"The title for the image gallery section.","type":"string"}},"type":"object"},"BrandPageConfigCallToAction":{"properties":{"text":{"type":"string"},"url":{"type":"string"}},"type":"object"},"BrandPageConfigProductGridContent":{"properties":{"cta":{"$ref":"#/components/schemas/BrandPageConfigCallToAction"},"products":{"items":{"$ref":"#/components/schemas/ProductGridContentProductGridProduct"},"type":"array"},"sectionDescription":{"type":"string"},"sectionTitle":{"type":"string"}},"type":"object"},"ProductGridContentProductGridProduct":{"properties":{"filterValues":{"items":{"type":"string"},"type":"array"},"order":{"format":"int32","type":"integer"},"product":{"$ref":"#/components/schemas/campaignv3CatalogProductSeller"}},"type":"object"},"BrandPageConfigSplitLayoutContent":{"properties":{"children":{"items":{"$ref":"#/components/schemas/BrandPageConfigSplitLayoutChild"},"type":"array"}},"type":"object"},"BrandPageConfigSplitLayoutChild":{"properties":{"nestedSplitLayout":{"$ref":"#/components/schemas/BrandPageConfigNestedSplitLayoutContent"},"nonLayout":{"$ref":"#/components/schemas/BrandPageConfigAllowedSplitLayoutChildContent"}},"type":"object"},"BrandPageConfigNestedSplitLayoutContent":{"properties":{"brandPageModuleTemplateId":{"description":"The template identifier for the brand page module.","type":"string"},"children":{"items":{"$ref":"#/components/schemas/BrandPageConfigAllowedSplitLayoutChildContent"},"type":"array"},"contentType":{"$ref":"#/components/schemas/BrandPageConfigBrandPageContentType"},"id":{"description":"The unique identifier for the nested split layout content.","type":"string"},"order":{"description":"The display order of the content.","format":"int32","type":"integer"}},"type":"object"},"BrandPageConfigAllowedSplitLayoutChildContent":{"properties":{"brandPageModuleTemplateId":{"description":"The template identifier for the brand page module.","type":"string"},"contentType":{"$ref":"#/components/schemas/BrandPageConfigBrandPageContentType"},"id":{"description":"The unique identifier for the split layout child content.","type":"string"},"image":{"$ref":"#/components/schemas/BrandPageConfigImageContent"},"order":{"description":"The display order of the content.","format":"int32","type":"integer"},"text":{"$ref":"#/components/schemas/BrandPageConfigTextContent"}},"type":"object"},"BrandPageConfigTextContent":{"properties":{"cta":{"$ref":"#/components/schemas/BrandPageConfigCallToAction"},"text":{"type":"string"},"textLines":{"$ref":"#/components/schemas/TextContentTextLines"}},"type":"object"},"TextContentTextLines":{"properties":{"lines":{"items":{"$ref":"#/components/schemas/TextContentTextContentLine"},"type":"array"}},"type":"object"},"BrandPageConfigEnabledAdTypes":{"enum":["ENABLED_AD_TYPES_DISPLAY","ENABLED_AD_TYPES_BANNER","ENABLED_AD_TYPES_BANNERX"],"type":"string"},"BrandPageConfigBrandPageFeatureVersion":{"enum":["BRAND_PAGE_FEATURE_VERSION_1","BRAND_PAGE_FEATURE_VERSION_3"],"type":"string"},"campaignv3CampaignState":{"enum":["CAMPAIGN_STATE_ACTIVE","CAMPAIGN_STATE_PAUSED","CAMPAIGN_STATE_DRAFT","CAMPAIGN_STATE_ARCHIVED"],"type":"string"},"campaignv3CustomField":{"properties":{"content":{"description":"The contents of the custom field.","type":"string"},"customFieldId":{"description":"The unique identifier of the custom field.","type":"string"}},"required":["customFieldId","content"],"type":"object"},"campaignv3CustomQuestion":{"properties":{"answers":{"description":"The selections of the advertiser relevant to the custom question.","items":{"type":"string"},"minItems":1,"type":"array","uniqueItems":true},"customQuestionId":{"description":"The ID of the custom question.","type":"string"}},"required":["customQuestionId","answers"],"type":"object"},"campaignv3FixedCosts":{"properties":{"creativeCost":{"description":"The cost associated with creative production for the campaign.","type":"string"},"dataCost":{"description":"The cost associated with data for the campaign.","type":"string"},"otherCost":{"description":"The cost associated with other expenses for the campaign.","type":"string"}},"type":"object"},"v3ServingState":{"enum":["SERVING_STATE_SCHEDULED","SERVING_STATE_COMPLETED"],"type":"string"},"v3CampaignSettings":{"properties":{"campaignType":{"$ref":"#/components/schemas/v3CampaignSettingsCampaignType"},"fromTime":{"description":"fromTime","format":"date-time","type":"string"},"toTime":{"description":"toTime","format":"date-time","type":"string"}},"type":"object"},"v3CampaignSettingsCampaignType":{"enum":["CAMPAIGN_TYPE_DISPLAY","CAMPAIGN_TYPE_BANNER","CAMPAIGN_TYPE_BANNERX","CAMPAIGN_TYPE_BRAND_PAGE","CAMPAIGN_TYPE_EMAIL","CAMPAIGN_TYPE_SAMPLES","CAMPAIGN_TYPE_SUBSTITUTIONS","CAMPAIGN_TYPE_PAST_ORDERS"],"type":"string"},"campaignv3Strategy":{"properties":{"auction":{"$ref":"#/components/schemas/campaignv3Auction"},"fixedTenancy":{"$ref":"#/components/schemas/campaignv3FixedTenancy"}},"type":"object"},"campaignv3Auction":{"properties":{"automatedBid":{"$ref":"#/components/schemas/v3AutomatedBid"},"maxBid":{"description":"The maximum cost per click for the campaign. For search targeted placements, any search term max bid defined against a search term will override the auction max bid.","type":"string"},"spendLimit":{"$ref":"#/components/schemas/campaignv3SpendLimit"}},"type":"object"},"v3AutomatedBid":{"properties":{"enableAutomatedBid":{"description":"Coming soon. Automate the bid adjustments.","type":"boolean"},"objectiveType":{"$ref":"#/components/schemas/v3ObjectiveType"},"targetRoas":{"description":"The target Return on Ad Spend. Required when objective_type is TARGET_ROAS.","type":"string"}},"type":"object"},"v3ObjectiveType":{"enum":["OBJECTIVE_TYPE_BUDGET_ONLY","OBJECTIVE_TYPE_MAX_CONVERSION_VALUE","OBJECTIVE_TYPE_MAX_CLICKS","OBJECTIVE_TYPE_MAX_IMPRESSIONS","OBJECTIVE_TYPE_TARGET_ROAS"],"type":"string"},"campaignv3SpendLimit":{"properties":{"daily":{"description":"This is the daily spend limit applied to the campaign. Depending on your retailer’s configuration, it may be a capped daily spend limit or an average daily limit where the campaign can dynamically spend up to a maximum of 2x the average daily limit to compensate for underspend.","type":"string"},"total":{"description":"Total spend limit.","type":"string"}},"type":"object"},"campaignv3FixedTenancy":{"properties":{"catalogCosts":{"items":{"$ref":"#/components/schemas/campaignv3CatalogCost"},"maxItems":5,"minItems":1,"type":"array","uniqueItems":true},"cost":{"description":"The cost of the campaign for reporting purposes. This value is not charged to the wallet.","type":"string"},"positions":{"description":"The fixed tenancy position booked by the campaign.","items":{"format":"int32","minimum":1,"type":"integer"},"maxItems":10,"minItems":1,"type":"array","uniqueItems":true}},"required":["cost","positions","catalogCosts"],"type":"object"},"campaignv3CatalogCost":{"properties":{"catalogCostPercentage":{"description":"The percentage of the campaign's cost allocated to the catalog.","format":"float","maximum":1,"type":"number"},"catalogId":{"description":"The unique identifier of the retailer's catalog.","type":"string"}},"required":["catalogId","catalogCostPercentage"],"type":"object"},"campaignv3Targeting":{"properties":{"audience":{"$ref":"#/components/schemas/v3Audience"},"crossSell":{"$ref":"#/components/schemas/campaignv3CrossSell"},"excludeFilters":{"description":"Used for integrations, excluding those with the filters enabled.","items":{"$ref":"#/components/schemas/campaignv3TargetedFilter"},"maxItems":250,"type":"array","uniqueItems":true},"includeFilters":{"description":"Used for integrations, including those with the filters enabled.","items":{"$ref":"#/components/schemas/campaignv3TargetedFilter"},"maxItems":250,"type":"array","uniqueItems":true},"negativeSearchTerms":{"description":"Used for placements that target search terms.","items":{"$ref":"#/components/schemas/v3NegativeSearchTerm"},"maxItems":500,"type":"array","uniqueItems":true},"searchTerms":{"description":"Used for placements that target search terms.","items":{"$ref":"#/components/schemas/campaignv3SearchTerm"},"maxItems":500,"type":"array","uniqueItems":true},"upsell":{"$ref":"#/components/schemas/campaignv3Upsell"}},"type":"object"},"v3Audience":{"properties":{"includeSegmentsSets":{"description":"Segment sets used for audience targeting combined by AND operator.","items":{"$ref":"#/components/schemas/v3SegmentsSet"},"maxItems":1,"type":"array"}},"type":"object"},"v3SegmentsSet":{"properties":{"segmentIds":{"description":"Segments used for audience targeting combined by OR operator.","items":{"type":"string"},"maxItems":100,"type":"array","uniqueItems":true}},"type":"object"},"campaignv3CrossSell":{"properties":{"targetProductsByAttributes":{"$ref":"#/components/schemas/campaignv3CrossSellTargetProductsByAttributes"},"targetProductsByKey":{"items":{"$ref":"#/components/schemas/campaignv3CatalogProductSeller"},"maxItems":250,"type":"array","uniqueItems":true}},"type":"object"},"campaignv3CrossSellTargetProductsByAttributes":{"properties":{"subclassTags":{"description":"Unique product subclass attributes as defined in the catalog.","items":{"type":"string"},"maxItems":10,"type":"array","uniqueItems":true},"vendorTags":{"description":"Unique product vendor attributes as defined in the catalog.","items":{"type":"string"},"type":"array","uniqueItems":true}},"type":"object"},"campaignv3TargetedFilter":{"properties":{"catalogId":{"description":"The unique identifier of the retailer's catalog.","type":"string"},"filter":{"description":"The product filter targeted by the campaign.","type":"string"}},"required":["catalogId","filter"],"type":"object"},"v3NegativeSearchTerm":{"properties":{"matchType":{"$ref":"#/components/schemas/v3NegativeSearchTermMatchType"},"phrase":{"description":"The negative search term.","type":"string"}},"required":["phrase","matchType"],"type":"object"},"v3NegativeSearchTermMatchType":{"enum":["MATCH_TYPE_EXACT_MATCH","MATCH_TYPE_PHRASE_MATCH"],"type":"string"},"campaignv3SearchTerm":{"properties":{"collectionName":{"description":"Used internally by Epsilon Retail Media. Omit unless advised by Epsilon Retail Media otherwise.","type":"string"},"excludedProducts":{"description":"Used internally by Epsilon Retail Media. Omit unless advised by Epsilon Retail Media otherwise.","items":{"$ref":"#/components/schemas/campaignv3CatalogProductSeller"},"readOnly":true,"type":"array"},"matchType":{"$ref":"#/components/schemas/campaignv3SearchTermMatchType"},"maxBid":{"description":"The maximum cost per click bid for the search term, overriding the auction's default max bid for that term.","type":"string"},"phrase":{"description":"The keyword you want to target in your campaign, with a maximum length of 150 characters.","type":"string"},"suggested":{"description":"Used internally by Epsilon Retail Media. Omit unless advised by Epsilon Retail Media otherwise.","readOnly":true,"type":"boolean"},"treatAsCustom":{"description":"Flag that determines whether the search term is treated as custom. Custom terms apply to all products in the campaign. This flag should only be used when the placement supports suggested search terms and allows custom terms.","type":"boolean"}},"required":["phrase","matchType"],"type":"object"},"campaignv3SearchTermMatchType":{"enum":["MATCH_TYPE_PHRASE_MATCH","MATCH_TYPE_EXACT_MATCH","MATCH_TYPE_BROAD_MATCH"],"type":"string"},"campaignv3Upsell":{"properties":{"targetProductsByAttributes":{"$ref":"#/components/schemas/campaignv3UpsellTargetProductsByAttributes"},"targetProductsByKey":{"items":{"$ref":"#/components/schemas/campaignv3CatalogProductSeller"},"maxItems":250,"type":"array","uniqueItems":true}},"type":"object"},"campaignv3UpsellTargetProductsByAttributes":{"properties":{"priceRange":{"$ref":"#/components/schemas/campaignv3PriceRange"},"subclassTags":{"description":"Unique product subclass attributes as defined in the catalog.","items":{"type":"string"},"maxItems":10,"type":"array","uniqueItems":true},"vendorTags":{"description":"Unique product vendor attributes as defined in the catalog.","items":{"type":"string"},"type":"array","uniqueItems":true}},"type":"object"},"rpcStatus":{"description":"The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).","properties":{"code":{"description":"The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].","format":"int32","type":"integer"},"details":{"description":"A list of messages that carry the error details.  There is a common set of\nmessage types for APIs to use.","items":{"$ref":"#/components/schemas/protobufAny"},"type":"array"},"message":{"description":"A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\n[google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.","type":"string"}},"type":"object"},"protobufAny":{"additionalProperties":{},"description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n    // or ...\n    if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n      foo = any.unpack(Foo.getDefaultInstance());\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := anypb.New(foo)\n     if err != nil {\n       ...\n     }\n     ...\n     foo := &pb.Foo{}\n     if err := any.UnmarshalTo(foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }","properties":{"@type":{"description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.","type":"string"}},"type":"object"}}},"paths":{"/v3/campaigns":{"post":{"description":"This endpoint retrieves a list of campaigns based on specified filters and parameters such as campaign name, campaign type, placement ID, team ID, approval state, and more. A date range (from and to) can be provided to narrow results based on the updateTime of the campaign. Pagination and sorting are supported to manage large datasets efficiently.","operationId":"listCampaigns","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v3ListCampaignsRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v3ListCampaignsResponse"}}},"description":"List of campaigns with pagination token for retrieving additional results."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}},"description":"There was a problem with input."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}},"description":"Login failed or token not valid."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}},"description":"Access denied due to insufficient permissions."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}},"description":"An unexpected error response."}},"summary":"Retrieve list of all campaigns","tags":["Campaign"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.citrusad.com/retail-media-interface/partner/ja/campaign-management-api/campaign/listcampaigns-1.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.