Skip to content

Methods Reference

This page is generated from the public Python SDK surface and the vendored Adobe OpenAPI spec. Use it as the primary wrapper reference. Adobe summaries and descriptions are sourced from the OpenAPI contract.

Root Client

  • TargetClient namespaces: activities, audiences, properties, offers, reports, environments, mboxes, profile_attributes, batch
  • Raw escape hatch: request(method, path, *, params=None, json=None, version=None, headers=None) -> httpx.Response

Activities

client.activities

client.activities.changelog

  • Signature: changelog(activity_id: str) -> ActivityChangelogList
  • Request model: none
  • Response model: ActivityChangelogList
  • Operation ID: getChangelog
  • Endpoint: GET /target/activities/{id}/changelog
  • Media type: application/vnd.adobe.target.v1+json
  • Adobe docs: Official API docs
  • Summary: List activity changelog
  • Description: Retrieve the changelog events related to the activity specified by ID

client.activities.list

  • Signature: list(*, params: ActivitiesListParams | None = None) -> ActivityList
  • Request model: none
  • Response model: ActivityList
  • Operation ID: getActivities
  • Endpoint: GET /target/activities
  • Media type: application/vnd.adobe.target.v3+json
  • Adobe docs: Official API docs
  • Summary: List activities
  • Description: Get a list of activities created in your Target account, with the ability to filter and sort by attributes.

client.activities.update_name

  • Signature: update_name(activity_id: str, payload: Name) -> ActivityDescription
  • Request model: Name
  • Response model: ActivityDescription
  • Operation ID: updateName
  • Endpoint: PUT /target/activities/{id}/name
  • Media type: application/vnd.adobe.target.v1+json
  • Adobe docs: Official API docs
  • Summary: Rename activity
  • Description: Rename the activity referenced by the provided ID. This change will be reflected in the Target user interface after the next refresh.

client.activities.update_priority

  • Signature: update_priority(activity_id: str, payload: Priority) -> ActivityDescription
  • Request model: Priority
  • Response model: ActivityDescription
  • Operation ID: updatePriority
  • Endpoint: PUT /target/activities/{id}/priority
  • Media type: application/vnd.adobe.target.v1+json
  • Adobe docs: Official API docs
  • Summary: Change activity priority
  • Description: Change the priority of the activity referenced by the provided ID. This will affect the way Target evaluates the activity selection at runtime. Allowed values for priority are 0-999. If you are using low, medium, and high in the Target UI, those correspond to 0, 5, and 10, respectively. You must turn on granular priority in the settings page in order to use the 0-999 scale.

client.activities.update_schedule

  • Signature: update_schedule(activity_id: str, payload: Schedule) -> ActivityDescription
  • Request model: Schedule
  • Response model: ActivityDescription
  • Operation ID: updateSchedule
  • Endpoint: PUT /target/activities/{id}/schedule
  • Media type: application/vnd.adobe.target.v1+json
  • Adobe docs: Official API docs
  • Summary: Update activity schedule
  • Description: Update the startsAt and endsAt fields of an activity referenced by the provided ID. This controls when the activity goes live. The schedule defines the start and end date and time for the activity. If successful, it returns a status code 200. In constructing the startsAt and endsAt values, follow ISO 8601 style date-hour formats.

client.activities.update_state

  • Signature: update_state(activity_id: str, payload: State) -> ActivityDescription
  • Request model: State
  • Response model: ActivityDescription
  • Operation ID: updateState
  • Endpoint: PUT /target/activities/{id}/state
  • Media type: application/vnd.adobe.target.v1+json
  • Adobe docs: Official API docs
  • Summary: Update activity state
  • Description: Update the state of the activity referenced by the provided ID. Valid values are approved, deactivated, deleted and saved.

Audiences

client.audiences

client.audiences.create

  • Signature: create(payload: Audience) -> Audience
  • Request model: Audience
  • Response model: Audience
  • Operation ID: createAudience
  • Endpoint: POST /target/audiences
  • Media type: application/vnd.adobe.target.v3+json
  • Adobe docs: Official API docs
  • Summary: Create audience
  • Description: Create a new audience as specified by the contents of the request and return the newly-created audience definition. Each audience definition is composed of either target or audience rules. Target rules allow the API caller to define conjunctions (OR) or disjunctions (AND) between various targeting conditions. Audience rules allow the API caller to build conjunctions (OR) or disjunctions (AND) over pre-built audiences (referred by IDs) to create even more powerful definitions. The targetRule and audienceRule attributes cannot be mixed within the same audience definition. Note: Audiences created using the API can only be edited using the API. You cannot edit an API-created audience in the UI, although you can use it within activities.

client.audiences.delete

  • Signature: delete(audience_id: str) -> Audience
  • Request model: none
  • Response model: Audience
  • Operation ID: deleteAudience
  • Endpoint: DELETE /target/audiences/{id}
  • Media type: application/vnd.adobe.target.v3+json
  • Adobe docs: Official API docs
  • Summary: Delete audience
  • Description: Delete the audience referenced by the specified ID.

client.audiences.get

  • Signature: get(audience_id: str) -> Audience
  • Request model: none
  • Response model: Audience
  • Operation ID: getAudience
  • Endpoint: GET /target/audiences/{id}
  • Media type: application/vnd.adobe.target.v3+json
  • Adobe docs: Official API docs
  • Summary: Get audience
  • Description: Get the audience definition specified by the provided ID.

client.audiences.list

  • Signature: list(*, params: AudiencesListParams | None = None) -> AudienceList
  • Request model: none
  • Response model: AudienceList
  • Operation ID: getAudiences
  • Endpoint: GET /target/audiences
  • Media type: application/vnd.adobe.target.v3+json
  • Adobe docs: Official API docs
  • Summary: List audiences
  • Description: List all available audiences with options to filter and sort by each available field. You can use the URL parameters to define pagination properties and sort order of the list of audiences returned by this method.

client.audiences.update

  • Signature: update(audience_id: str, payload: Audience) -> Audience
  • Request model: Audience
  • Response model: Audience
  • Operation ID: updateAudience
  • Endpoint: PUT /target/audiences/{id}
  • Media type: application/vnd.adobe.target.v3+json
  • Adobe docs: Official API docs
  • Summary: Update audience
  • Description: Update an audience with the new rules specified by the request data.

Properties

client.properties

client.properties.get

  • Signature: get(property_id: str) -> Property
  • Request model: none
  • Response model: Property
  • Operation ID: getProperty
  • Endpoint: GET /target/properties/{id}
  • Media type: application/vnd.adobe.target.v1+json
  • Adobe docs: Official API docs
  • Summary: Get a property by ID
  • Description: Retrieve the current definition of a property referenced by the property ID.

client.properties.list

  • Signature: list() -> PropertyList
  • Request model: none
  • Response model: PropertyList
  • Operation ID: getProperties
  • Endpoint: GET /target/properties
  • Media type: application/vnd.adobe.target.v1+json
  • Adobe docs: Official API docs
  • Summary: List properties
  • Description: Retrieve list of all properties.

Offers

client.offers

client.offers.list

  • Signature: list() -> OfferList
  • Request model: none
  • Response model: OfferList
  • Operation ID: getOffers
  • Endpoint: GET /target/offers
  • Media type: application/vnd.adobe.target.v2+json
  • Adobe docs: Official API docs
  • Summary: List offers
  • Description: Retrieve the list of previously-created content/JSON/Recommendations offers. The parameters passed through the query string are optional and are used to indicate the sorting and filtering options.

Reports

client.reports

Environments

client.environments

client.environments.list

  • Signature: list() -> EnvironmentList
  • Request model: none
  • Response model: EnvironmentList
  • Operation ID: getEnvironments
  • Endpoint: GET /target/environments
  • Media type: application/vnd.adobe.target.v1+json
  • Adobe docs: Official API docs
  • Summary: List environments
  • Description: Retrieve all available environments with the options to filter and sort. Use the Environments API to retrieve the environment IDs corresponding to the various host groups set for the client.

Mboxes

client.mboxes

client.mboxes.list

  • Signature: list() -> MboxList
  • Request model: none
  • Response model: MboxList
  • Operation ID: getMboxes
  • Endpoint: GET /target/mboxes
  • Media type: application/vnd.adobe.target.v1+json
  • Adobe docs: Official API docs
  • Summary: List available mboxes
  • Description: List all available mboxes for a specific client with the options to filter and sort.

client.mboxes.parameters

  • Signature: parameters(mbox_name: str) -> Mbox
  • Request model: none
  • Response model: Mbox
  • Operation ID: getMbox
  • Endpoint: GET /target/mbox/{mboxName}
  • Media type: application/vnd.adobe.target.v1+json
  • Adobe docs: Official API docs
  • Summary: Get mbox parameters
  • Description: Get the list of mbox parameters.

Profile Attributes

client.profile_attributes

client.profile_attributes.list

  • Signature: list() -> MboxProfileAttributesDTO
  • Request model: none
  • Response model: MboxProfileAttributesDTO
  • Operation ID: getMboxProfileAttributes
  • Endpoint: GET /target/profileattributes/mbox
  • Media type: application/vnd.adobe.target.v1+json
  • Adobe docs: Official API docs
  • Summary: List profile attributes
  • Description: Retrieve the list of available profile attributes and mbox parameters of type profile.

Batch

client.batch

client.batch.execute

  • Signature: execute(payload: BatchRequest) -> BatchResponse
  • Request model: BatchRequest
  • Response model: BatchResponse
  • Operation ID: processBatchOperations
  • Endpoint: POST /target/batch
  • Media type: application/json
  • Adobe docs: Official API docs
  • Summary: Execute Calls in Batch
  • Description: Stack multiple REST API calls together and execute them in a single batch.

Activities AB

client.activities.ab

client.activities.ab.create

  • Signature: create(payload: ABActivity) -> ABActivity
  • Request model: ABActivity
  • Response model: ABActivity
  • Operation ID: createActivity_3
  • Endpoint: POST /target/activities/ab
  • Media type: application/vnd.adobe.target.v3+json
  • Adobe docs: Official API docs
  • Summary: Create AB activity
  • Description: Create a new AB activity based on the specified contents, and return the created activity.

client.activities.ab.delete

  • Signature: delete(activity_id: str) -> ABActivity
  • Request model: none
  • Response model: ABActivity
  • Operation ID: deleteActivity_3
  • Endpoint: DELETE /target/activities/ab/{id}
  • Media type: application/vnd.adobe.target.v3+json
  • Adobe docs: Official API docs
  • Summary: Delete AB activity
  • Description: Delete the AB activity referenced by the provided ID.

client.activities.ab.get

  • Signature: get(activity_id: str) -> ABActivity
  • Request model: none
  • Response model: ABActivity
  • Operation ID: getActivity_3
  • Endpoint: GET /target/activities/ab/{id}
  • Media type: application/vnd.adobe.target.v3+json
  • Adobe docs: Official API docs
  • Summary: Get AB activity by ID
  • Description: Fetch the current definition of an AB activity as referenced by the provided ID.

client.activities.ab.update

  • Signature: update(activity_id: str, payload: ABActivity) -> ABActivity
  • Request model: ABActivity
  • Response model: ABActivity
  • Operation ID: updateActivity_3
  • Endpoint: PUT /target/activities/ab/{id}
  • Media type: application/vnd.adobe.target.v3+json
  • Adobe docs: Official API docs
  • Summary: Update AB activity
  • Description: Update the AB activity definition with the contents as provided in the request. This can change the state and behaviour of an existing activity.

Activities XT

client.activities.xt

client.activities.xt.create

  • Signature: create(payload: ABActivity) -> ABActivity
  • Request model: ABActivity
  • Response model: ABActivity
  • Operation ID: createActivity_4
  • Endpoint: POST /target/activities/xt
  • Media type: application/vnd.adobe.target.v3+json
  • Adobe docs: Official API docs
  • Summary: Create XT activity
  • Description: Create a new Experience Targeting activity based on the specified contents, and return the created activity.

client.activities.xt.delete

  • Signature: delete(activity_id: str) -> ABActivity
  • Request model: none
  • Response model: ABActivity
  • Operation ID: deleteActivity_4
  • Endpoint: DELETE /target/activities/xt/{id}
  • Media type: application/vnd.adobe.target.v3+json
  • Adobe docs: Official API docs
  • Summary: Delete XT activity
  • Description: Delete the Experience Targeting activity referenced by the provided ID.

client.activities.xt.get

  • Signature: get(activity_id: str) -> ABActivity
  • Request model: none
  • Response model: ABActivity
  • Operation ID: getActivity_4
  • Endpoint: GET /target/activities/xt/{id}
  • Media type: application/vnd.adobe.target.v3+json
  • Adobe docs: Official API docs
  • Summary: Get XT activity by ID
  • Description: Fetch the current definition of an Experience Targeting activity as referenced by the provided ID.

client.activities.xt.update

  • Signature: update(activity_id: str, payload: ABActivity) -> ABActivity
  • Request model: ABActivity
  • Response model: ABActivity
  • Operation ID: updateActivity_4
  • Endpoint: PUT /target/activities/xt/{id}
  • Media type: application/vnd.adobe.target.v3+json
  • Adobe docs: Official API docs
  • Summary: Update XT activity
  • Description: Update an Experience Targeting activity definition with the contents as provided in the request. This can change the state and behaviour of an existing activity.

Offers Content

client.offers.content

client.offers.content.create

  • Signature: create(payload: ContentOffer) -> ContentOffer
  • Request model: ContentOffer
  • Response model: ContentOffer
  • Operation ID: createOffer_2
  • Endpoint: POST /target/offers/content
  • Media type: application/vnd.adobe.target.v2+json
  • Adobe docs: Official API docs
  • Summary: Create a new content offer
  • Description: Creates a new content offer as defined by the request data.

client.offers.content.delete

  • Signature: delete(offer_id: str) -> ContentOffer
  • Request model: none
  • Response model: ContentOffer
  • Operation ID: deleteOffer_2
  • Endpoint: DELETE /target/offers/content/{id}
  • Media type: application/vnd.adobe.target.v2+json
  • Adobe docs: Official API docs
  • Summary: Delete a content offer by ID
  • Description: Deletes the content offer referenced by the provided ID.

client.offers.content.get

  • Signature: get(offer_id: str) -> ContentOffer
  • Request model: none
  • Response model: ContentOffer
  • Operation ID: getOffer_2
  • Endpoint: GET /target/offers/content/{id}
  • Media type: application/vnd.adobe.target.v2+json
  • Adobe docs: Official API docs
  • Summary: Get content offer by ID
  • Description: Retrieves the contents of the content offer referenced by the provided ID.

client.offers.content.update

  • Signature: update(offer_id: str, payload: ContentOffer) -> ContentOffer
  • Request model: ContentOffer
  • Response model: ContentOffer
  • Operation ID: updateOffer_2
  • Endpoint: PUT /target/offers/content/{id}
  • Media type: application/vnd.adobe.target.v2+json
  • Adobe docs: Official API docs
  • Summary: Update a content offer by ID
  • Description: Updates the content offer referenced by the ID specified in the URL.

Reports AB

client.reports.ab

client.reports.ab.orders

  • Signature: orders(activity_id: str) -> ActivityOrdersReport
  • Request model: none
  • Response model: ActivityOrdersReport
  • Operation ID: getReportById_4
  • Endpoint: GET /target/activities/ab/{id}/report/orders
  • Media type: application/vnd.adobe.target.v1+json
  • Adobe docs: Official API docs
  • Summary: Get XT orders report
  • Description: Retrieve orders report data for the Experience Targeting activity referenced by the provided ID.

client.reports.ab.performance

  • Signature: performance(activity_id: str) -> AbstractActivityPerformanceReport
  • Request model: none
  • Response model: AbstractActivityPerformanceReport
  • Operation ID: getReportById_2
  • Endpoint: GET /target/activities/ab/{id}/report/performance
  • Media type: application/vnd.adobe.target.v1+json
  • Adobe docs: Official API docs
  • Summary: Get AB performance report
  • Description: Retrieve performance report data for the AB activity referenced by the provided ID.

Reports XT

client.reports.xt

client.reports.xt.orders

  • Signature: orders(activity_id: str) -> ActivityOrdersReport
  • Request model: none
  • Response model: ActivityOrdersReport
  • Operation ID: getReportById_5
  • Endpoint: GET /target/activities/xt/{id}/report/orders
  • Media type: application/vnd.adobe.target.v1+json
  • Adobe docs: Official API docs
  • Summary: Get XT orders report
  • Description: Retrieve orders report data for the Experience Targeting activity referenced by the provided ID.

client.reports.xt.performance

  • Signature: performance(activity_id: str) -> AbstractActivityPerformanceReport
  • Request model: none
  • Response model: AbstractActivityPerformanceReport
  • Operation ID: getReportById_3
  • Endpoint: GET /target/activities/xt/{id}/report/performance
  • Media type: application/vnd.adobe.target.v1+json
  • Adobe docs: Official API docs
  • Summary: Get XT performance report
  • Description: Retrieve performance report data for the Experience Targeting activity referenced by the provided ID.

Reports ABT

client.reports.abt

client.reports.abt.orders

  • Signature: orders(activity_id: str) -> ActivityOrdersReport
  • Request model: none
  • Response model: ActivityOrdersReport
  • Operation ID: getReportById_1
  • Endpoint: GET /target/activities/abt/{id}/report/orders
  • Media type: application/vnd.adobe.target.v1+json
  • Adobe docs: Official API docs
  • Summary: Get AP orders report
  • Description: Retrieve orders report data for the Automated Personalization activity referenced by the provided ID.

client.reports.abt.performance

  • Signature: performance(activity_id: str) -> AbstractActivityPerformanceReport
  • Request model: none
  • Response model: AbstractActivityPerformanceReport
  • Operation ID: getReportById
  • Endpoint: GET /target/activities/abt/{id}/report/performance
  • Media type: application/vnd.adobe.target.v1+json
  • Adobe docs: Official API docs
  • Summary: Get AP performance report
  • Description: Retrieve performance report data for the Automated Personalization activity referenced by the provided ID.

API Classes

The full class and signature reference is available on the separate Class Reference page generated by mkdocstrings.