> 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/fr/campaign-management-api/productcampaign-1/getproductcampaign-1.md). # Obtenir la campagne de produits pour l'ID spécifié ## Get product campaign for specified ID > This endpoint retrieves the complete details of a specific product campaign using its unique ID. View all campaign settings, performance data, and current status. Note: requestTeamId is required for supplier (advertiser) users and must match the team that owns the campaign. Retailer users may omit it. Requests from supplier users without a valid requestTeamId will fail with a 400 or 403 error. ```json {"openapi":"3.0.0","info":{"title":"Citrus Campaign APIs","version":"v3"},"tags":[],"servers":[{"url":"https://campaign..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":{"campaignv3GetProductCampaignResponse":{"properties":{"productCampaign":{"$ref":"#/components/schemas/campaignv3ProductCampaign"}},"required":["productCampaign"],"type":"object"},"campaignv3ProductCampaign":{"properties":{"advertisedProducts":{"$ref":"#/components/schemas/campaignv3AdvertisedProducts"},"approval":{"$ref":"#/components/schemas/campaignv3Approval"},"campaignState":{"$ref":"#/components/schemas/campaignv3CampaignState"},"catalogIds":{"description":"The unique identifier of the retailer's catalog. At least one catalog ID is required when creating a campaign.","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":"The integration for campaigns utilizing 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. Server-generated on create; required when updating.","readOnly":true,"type":"string"},"managerTeamId":{"description":"The retailer manager's team ID for the campaign. It applies only to fixed tenancy campaigns.","type":"string"},"name":{"description":"The name of the campaign. Required when creating a campaign.","type":"string"},"namespaceId":{"description":"The unique identifier of the namespace. Required when creating a campaign.","type":"string"},"placementId":{"description":"The unique identifier of the campaign's placement. Required when creating a campaign and cannot be changed afterwards.","type":"string"},"sellerId":{"description":"The seller ID of the campaign. Defaults to an empty string if null.","type":"string"},"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. Required when creating a campaign. The caller must have ROLE_CAMPAIGN_EDITOR permission on this team (or admin role).","type":"string"},"templateId":{"description":"The unique identifier of the campaign template.","type":"string"},"updateTime":{"description":"The last time the entity was updated as a precise ISO-8601 timestamp.","format":"date-time","readOnly":true,"type":"string"},"walletId":{"description":"The unique identifier of the wallet to be charged for the campaign. Required when creating a 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":{"default":"APPROVAL_STATE_PENDING","enum":["APPROVAL_STATE_PENDING","APPROVAL_STATE_APPROVED","APPROVAL_STATE_REJECTED"],"type":"string"},"campaignv3CampaignState":{"default":"CAMPAIGN_STATE_ACTIVE","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"},"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":{"default":"OBJECTIVE_TYPE_UNSPECIFIED","enum":["OBJECTIVE_TYPE_UNSPECIFIED","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":{"default":"MATCH_TYPE_UNSPECIFIED","enum":["MATCH_TYPE_UNSPECIFIED","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":{"default":"MATCH_TYPE_UNSPECIFIED","enum":["MATCH_TYPE_UNSPECIFIED","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\": ,\n \"lastName\": \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/product-campaigns/{id}":{"get":{"description":"This endpoint retrieves the complete details of a specific product campaign using its unique ID. View all campaign settings, performance data, and current status. Note: requestTeamId is required for supplier (advertiser) users and must match the team that owns the campaign. Retailer users may omit it. Requests from supplier users without a valid requestTeamId will fail with a 400 or 403 error.","operationId":"getProductCampaign","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/campaignv3GetProductCampaignResponse"}}},"description":"The product campaign object for requested id."},"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."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}},"description":"Product campaign for specified id does not exist."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}},"description":"An unexpected error response."}},"summary":"Get product campaign for specified ID","tags":["productCampaign"]}}}} ``` --- # 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/fr/campaign-management-api/productcampaign-1/getproductcampaign-1.md?ask=&goal= ``` `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.