# A2 Resources ## Docs - [Record Activity Log](https://docs.aiderx.io/data management/activity-log/record-activity-log.md): Records user activity logs for advertising optimization and analytics. - [Create an allocation](https://docs.aiderx.io/data management/allocation/create-an-allocation.md): Create a new allocation between a campaign and placement. - [Delete an allocation](https://docs.aiderx.io/data management/allocation/delete-an-allocation.md): Delete an allocation between a campaign and placement. - [Get an allocation](https://docs.aiderx.io/data management/allocation/get-an-allocation.md): Retrieve an allocation by querying with placement ID (tagid), campaign ID (cid), creative ID (crid) and owner ID. If multiple allocations match the query parameters, only the first result will be returned. - [Get multiple allocations](https://docs.aiderx.io/data management/allocation/get-multiple-allocations.md): Retrieve allocations by querying with placement ID (tagid), campaign ID (cid), creative ID (crid) and owner ID. Returns all allocations that match the query parameters. - [Update an allocation](https://docs.aiderx.io/data management/allocation/update-an-allocation.md): Update an existing allocation between a campaign and placement. - [Get a campaign attribute daily metric](https://docs.aiderx.io/data management/analytic/get-a-campaign-attribute-daily-metric.md): Retrieves daily campaign attribute metrics for the specified time range. - [Get a campaign attribute hourly metric](https://docs.aiderx.io/data management/analytic/get-a-campaign-attribute-hourly-metric.md): Retrieves hourly campaign attribute metrics for the specified time range. - [Get a campaign attribute metric](https://docs.aiderx.io/data management/analytic/get-a-campaign-attribute-metric.md): Retrieves metrics for a specific campaign attribute identified by the query. - [Get a campaign daily metric](https://docs.aiderx.io/data management/analytic/get-a-campaign-daily-metric.md): Retrieves daily campaign metrics for the specified time range. - [Get a campaign hourly metric](https://docs.aiderx.io/data management/analytic/get-a-campaign-hourly-metric.md): Retrieves hourly campaign metrics for the specified time range. - [Get a campaign metric](https://docs.aiderx.io/data management/analytic/get-a-campaign-metric.md): Retrieves metrics for a specific campaign identified by the query. - [Get a placement daily metric](https://docs.aiderx.io/data management/analytic/get-a-placement-daily-metric.md): Retrieves daily placement metrics for the specified time range. - [Get a placement hourly metric](https://docs.aiderx.io/data management/analytic/get-a-placement-hourly-metric.md): Retrieves hourly placement metrics for the specified time range. - [Get a placement metric](https://docs.aiderx.io/data management/analytic/get-a-placement-metric.md): Retrieves metrics for a specific placement identified by the query. - [Get dashboard data](https://docs.aiderx.io/data management/analytic/get-dashboard-data.md): Returns general A2 statistics and campaign performance data. - [Create an audience attribute](https://docs.aiderx.io/data management/audience-attribute/create-an-audience-attribute.md): Creates a new audience attribute. - [Create an audience attribute value](https://docs.aiderx.io/data management/audience-attribute/create-an-audience-attribute-value.md): Creates an audience attribute value. - [Create multiple audience attribute values](https://docs.aiderx.io/data management/audience-attribute/create-multiple-audience-attribute-values.md): Creates multiple audience attribute values in a single operation. - [Create multiple audience attributes](https://docs.aiderx.io/data management/audience-attribute/create-multiple-audience-attributes.md): Creates multiple audience attributes in a single operation. - [Delete an audience attribute](https://docs.aiderx.io/data management/audience-attribute/delete-an-audience-attribute.md): Deletes an audience attribute. - [Delete an audience attribute value](https://docs.aiderx.io/data management/audience-attribute/delete-an-audience-attribute-value.md): Deletes an audience attribute value. - [Delete multiple audience attribute values](https://docs.aiderx.io/data management/audience-attribute/delete-multiple-audience-attribute-values.md): Deletes multiple audience attribute values in a single operation. - [Delete multiple audience attributes](https://docs.aiderx.io/data management/audience-attribute/delete-multiple-audience-attributes.md): Deletes multiple audience attributes in a single operation. - [Get an audience attribute](https://docs.aiderx.io/data management/audience-attribute/get-an-audience-attribute.md): Retrieves an audience attribute by its ID. - [Get multiple audience attribute values](https://docs.aiderx.io/data management/audience-attribute/get-multiple-audience-attribute-values.md): Retrieves attribute values matching query conditions. - [Get multiple audience attributes](https://docs.aiderx.io/data management/audience-attribute/get-multiple-audience-attributes.md): Retrieves audience attributes matching query conditions. - [Update an audience attribute](https://docs.aiderx.io/data management/audience-attribute/update-an-audience-attribute.md): Updates an existing audience attribute. - [Create an audience segment](https://docs.aiderx.io/data management/audience-segment/create-an-audience-segment.md): Creates an audience segment. - [Create multiple audience segments](https://docs.aiderx.io/data management/audience-segment/create-multiple-audience-segments.md): Creates multiple audience segments in a single operation. - [Delete an audience segment](https://docs.aiderx.io/data management/audience-segment/delete-an-audience-segment.md): Deletes an audience segment. - [Delete multiple audience segments](https://docs.aiderx.io/data management/audience-segment/delete-multiple-audience-segments.md): Deletes multiple audience segments in a single operation. - [Get multiple audience segments](https://docs.aiderx.io/data management/audience-segment/get-multiple-audience-segments.md): Retrieves audience segments matching query conditions. - [Update an audience segment](https://docs.aiderx.io/data management/audience-segment/update-an-audience-segment.md): Updates an audience segment. - [Create an audience](https://docs.aiderx.io/data management/audience/create-an-audience.md): Creates a new audience and returns information about the created audience. - [Create multiple audiences](https://docs.aiderx.io/data management/audience/create-multiple-audiences.md): Creates multiple audiences in a single operation. - [Delete an audience](https://docs.aiderx.io/data management/audience/delete-an-audience.md): Deletes an audience by ID. - [Delete multiple audiences](https://docs.aiderx.io/data management/audience/delete-multiple-audiences.md): Deletes multiple audiences in a single operation. - [Get an audience](https://docs.aiderx.io/data management/audience/get-an-audience.md): Retrieves an audience by its ID. - [Get audiences count](https://docs.aiderx.io/data management/audience/get-audiences-count.md): Get the total count of audiences in the system. - [Get multiple audiences](https://docs.aiderx.io/data management/audience/get-multiple-audiences.md): Retrieves all audiences matching the query conditions. - [Update an audience](https://docs.aiderx.io/data management/audience/update-an-audience.md): Updates an existing audience with new information. - [Delete a user](https://docs.aiderx.io/data management/auth-and-user/delete-a-user.md): Delete the user. This is only available for the admin. - [Get a privacy consent](https://docs.aiderx.io/data management/auth-and-user/get-a-privacy-consent.md): Retrieves all privacy consents for a specific user based on the provided user ID. - [Get all users](https://docs.aiderx.io/data management/auth-and-user/get-all-users.md): Retrieve all users. This is available for administrators and retailers. - [Get the current user](https://docs.aiderx.io/data management/auth-and-user/get-the-current-user.md): Retrieves the current user's information. - [Google sign-in authentication.](https://docs.aiderx.io/data management/auth-and-user/google-sign-in-authentication.md): Logs in the user using Google authentication. - [Login using JWT authentication.](https://docs.aiderx.io/data management/auth-and-user/login-using-jwt-authentication.md): Logs in the user using JWT authentication. - [Logout using JWT authentication.](https://docs.aiderx.io/data management/auth-and-user/logout-using-jwt-authentication.md): Logs out the current user using JWT authentication. - [Register a new user](https://docs.aiderx.io/data management/auth-and-user/register-a-new-user.md): Creates a new user account in the system with the provided credentials and information. - [Request a verification token](https://docs.aiderx.io/data management/auth-and-user/request-a-verification-token.md): Generates a verification token and sends it to the user's email address. The user must have received a verification token via email. - [Request password reset](https://docs.aiderx.io/data management/auth-and-user/request-password-reset.md): Initiates the password recovery process by sending a reset link to the user's registered email address. The user can then follow this link to create a new password. - [Reset password](https://docs.aiderx.io/data management/auth-and-user/reset-password.md): Allows the user to reset their password using a verification token. The user must have received a verification token via email. - [Update user budget](https://docs.aiderx.io/data management/auth-and-user/update-user-budget.md): Update the user's budget. This is only available if the user has budget update permission. - [Update user data](https://docs.aiderx.io/data management/auth-and-user/update-user-data.md): Update the user's data. - [Upsert a privacy consent](https://docs.aiderx.io/data management/auth-and-user/upsert-a-privacy-consent.md): Creates or updates privacy consents for a user. - [Verify the user token](https://docs.aiderx.io/data management/auth-and-user/verify-the-user-token.md): Verifies the user token and logs the user in. The user must have received a verification token via email. - [Forward to external url](https://docs.aiderx.io/data management/billing/forward-to-external-url.md): This endpoint forwards the requested content to the registered external channel and returns the response exactly as received. It acts as a proxy between the client and the external service. - [Get a payment](https://docs.aiderx.io/data management/billing/get-a-payment.md): Retrieves a specific payment based on the provided payment ID. - [Get multiple payments](https://docs.aiderx.io/data management/billing/get-multiple-payments.md): Retrieves all payments of a current user. - [Create a campaign](https://docs.aiderx.io/data management/campaign/create-a-campaign.md): Creates a new advertising campaign and returns information about the created campaign. - [Delete a campaign](https://docs.aiderx.io/data management/campaign/delete-a-campaign.md): Deletes an existing campaign with the specified ID. - [Get a campaign](https://docs.aiderx.io/data management/campaign/get-a-campaign.md): Retrieves detailed information about a specific campaign by its ID. - [Get multiple campaigns](https://docs.aiderx.io/data management/campaign/get-multiple-campaigns.md): Retrieve all campaigns that match the specified query conditions. - [Update a campaign](https://docs.aiderx.io/data management/campaign/update-a-campaign.md): Updates an existing advertising campaign and returns information about the updated campaign. - [Create a catalog](https://docs.aiderx.io/data management/catalog/create-a-catalog.md): Creates a new catalog and returns information about the created catalog. - [Create multiple catalogs](https://docs.aiderx.io/data management/catalog/create-multiple-catalogs.md): Creates multiple new catalogs in a single request. - [Delete a catalog](https://docs.aiderx.io/data management/catalog/delete-a-catalog.md): Deletes an existing catalog with the specified ID. - [Delete multiple catalogs](https://docs.aiderx.io/data management/catalog/delete-multiple-catalogs.md): Deletes multiple existing catalogs in a single request. - [Get a catalog](https://docs.aiderx.io/data management/catalog/get-a-catalog.md): Retrieves detailed information about a specific catalog by its ID. - [Get multiple catalogs](https://docs.aiderx.io/data management/catalog/get-multiple-catalogs.md): Retrieves a paginated list of all catalogs that match the specified query conditions. - [Update a catalog](https://docs.aiderx.io/data management/catalog/update-a-catalog.md): Updates an existing catalog and returns information about the updated catalog. - [Create a creative](https://docs.aiderx.io/data management/creative/create-a-creative.md): Creates a new creative asset and returns information about the created creative. - [Delete a creative](https://docs.aiderx.io/data management/creative/delete-a-creative.md): Deletes an existing creative asset with the specified ID. - [Get a creative](https://docs.aiderx.io/data management/creative/get-a-creative.md): Retrieves a creative asset by its ID - [Get multiple creatives](https://docs.aiderx.io/data management/creative/get-multiple-creatives.md): Retrieve all creative assets that match the specified query conditions. - [Update a creative](https://docs.aiderx.io/data management/creative/update-a-creative.md): Updates an existing creative asset by its ID and returns the updated creative information. - [Get license features](https://docs.aiderx.io/data management/license/get-license-features.md): Get the list of features supported by the current license. - [Get license metrics](https://docs.aiderx.io/data management/license/get-license-metrics.md): Get the current license metrics. - [Delete media library file](https://docs.aiderx.io/data management/media-library/delete-media-library-file.md): Deletes a file from the media library. - [Get media library](https://docs.aiderx.io/data management/media-library/get-media-library.md): Retrieves all media library items that belong to the specified user ID. - [Upload media library file](https://docs.aiderx.io/data management/media-library/upload-media-library-file.md): Uploads a file to the media library and returns the created media library entry. - [Create a placement catalog](https://docs.aiderx.io/data management/placement-catalog/create-a-placement-catalog.md): Create a placement catalog. - [Delete a placement catalog](https://docs.aiderx.io/data management/placement-catalog/delete-a-placement-catalog.md): Delete a placement catalog. - [Get a placement catalog](https://docs.aiderx.io/data management/placement-catalog/get-a-placement-catalog.md): Retrieves a placement catalog based on the provided ID. - [Get a placement catalog share](https://docs.aiderx.io/data management/placement-catalog/get-a-placement-catalog-share.md): Retrieves a specific placement catalog share by its ID. - [Get a placement catalog share view](https://docs.aiderx.io/data management/placement-catalog/get-a-placement-catalog-share-view.md): Retrieves a placement catalog's shared view including placements. Requires password if protected. - [Get all placement catalogs](https://docs.aiderx.io/data management/placement-catalog/get-all-placement-catalogs.md): Retrieves a list of all placement catalogs. - [Update a placement catalog](https://docs.aiderx.io/data management/placement-catalog/update-a-placement-catalog.md): Update a placement catalog. - [Update a placement catalog share](https://docs.aiderx.io/data management/placement-catalog/update-a-placement-catalog-share.md): Update a placement catalog share. - [Create a placement](https://docs.aiderx.io/data management/placement/create-a-placement.md): Creates a new placement for advertising content and returns information about the created placement. - [Delete a placement](https://docs.aiderx.io/data management/placement/delete-a-placement.md): Deletes a placement based on the provided ID. - [Get a placement](https://docs.aiderx.io/data management/placement/get-a-placement.md): Retrieves a placement based on the provided ID. - [Get multiple placements](https://docs.aiderx.io/data management/placement/get-multiple-placements.md): Retrieves a list of all placements available to the current user. - [Update a placement](https://docs.aiderx.io/data management/placement/update-a-placement.md): Updates an existing placement with new information and returns the updated placement details. - [Create a notification](https://docs.aiderx.io/data management/system/create-a-notification.md): Creates a new notification for a user in the system and returns the created notification details. - [Delete a notification](https://docs.aiderx.io/data management/system/delete-a-notification.md): Deletes a specific notification by its ID. Only the user who owns the notification can delete it. - [Get audit logs](https://docs.aiderx.io/data management/system/get-audit-logs.md): Retrieve system audit logs with optional filtering. This endpoint returns a list of system audit logs that track various system events and user actions. The logs can be filtered by: - Event types - User ID - User email - Date range (start date and end date) Each… - [Get current logo](https://docs.aiderx.io/data management/system/get-current-logo.md): Retrieves the current logo image used in the system. - [Get notifications](https://docs.aiderx.io/data management/system/get-notifications.md): Retrieves a list of notifications based on the provided query parameters. - [Get Settings](https://docs.aiderx.io/data management/system/get-settings.md): Retrieves the current system settings. - [Health check](https://docs.aiderx.io/data management/system/health-check.md) - [Mark a notification as read](https://docs.aiderx.io/data management/system/mark-a-notification-as-read.md): Marks a specific notification as read for a user. This endpoint updates the read status of a notification identified by its ID. - [Regenerate access token](https://docs.aiderx.io/data management/system/regenerate-access-token.md): Regenerates a new access token for the system. - [Update settings](https://docs.aiderx.io/data management/system/update-settings.md): Updates system settings except for TLS configuration. Use this endpoint to modify general system settings while keeping TLS settings unchanged. - [Update TLS configuration](https://docs.aiderx.io/data management/system/update-tls-configuration.md): Updates the TLS (Transport Layer Security) configuration for the system. - [Upload site logo](https://docs.aiderx.io/data management/system/upload-site-logo.md): Uploads a custom logo for the site. This endpoint allows administrators to change the site's branding by uploading a new logo image that will be displayed throughout the application interface. - [Record Activity Log](https://docs.aiderx.io/decision/activity-log/record-activity-log.md): Records user activity logs for advertising optimization and analytics. - [/dmp/v0/log](https://docs.aiderx.io/decision/ad-log/dmpv0log.md): Records ad interaction events for advertising optimization and analytics. - [Serving an ad](https://docs.aiderx.io/decision/ad-serving/serving-an-ad.md): Serves an ad based on the placement tag (`tagid`) and request payload (`AdRequest`). Selects the most appropriate ad using campaign, creative, and bidding strategy data. Returns the final ad determined through DSP response and internal mediation logic. - [Delete Allocations](https://docs.aiderx.io/decision/cache-management/delete-allocations.md): Removes allocation information from the cache. Targets are identified by a list of `(cid, pid)` pairs in the request body. - [Delete Campaigns](https://docs.aiderx.io/decision/cache-management/delete-campaigns.md): Removes campaign information from the cache. Targets are identified by campaign ID list in the request body. - [Delete Creatives](https://docs.aiderx.io/decision/cache-management/delete-creatives.md): Removes creative information from the cache. Targets are identified by a list of `(cid, crid)` pairs in the request body. - [Delete Placements](https://docs.aiderx.io/decision/cache-management/delete-placements.md): Removes placement information from the cache. Targets are identified by placement ID list in the request body. - [Update Allocations](https://docs.aiderx.io/decision/cache-management/update-allocations.md): Stores allocation information between placements and campaigns. Used to determine eligible campaigns during mediation. - [Update Campaigns](https://docs.aiderx.io/decision/cache-management/update-campaigns.md): Stores campaign information in the cache. Used during ad selection and mediation logic. - [Update Creatives](https://docs.aiderx.io/decision/cache-management/update-creatives.md): Stores creative information in the cache. Used to build ad responses during ad serving. - [Update Placements](https://docs.aiderx.io/decision/cache-management/update-placements.md): Stores placement information in the cache. Used to update serving logic based on placement metadata. - [Update Bid Strategy](https://docs.aiderx.io/decision/configuration/update-bid-strategy.md): Stores or updates global bid strategy configuration. Used to calculate bidding prices during ad serving. - [Deploying A2 OnPrem on AWS](https://docs.aiderx.io/development/en/deployment-aws.md): This guide explains how to deploy A2 OnPrem on Amazon Web Service (AWS). - [Deploying A2 OnPrem to GCP](https://docs.aiderx.io/development/en/deployment-gcp.md): This guide explains how to deploy A2 OnPrem to Google Cloud Platform (GCP). - [Ad Log Integration Guide](https://docs.aiderx.io/development/en/log-integration-data-migration.md): This guide introduces methods for advertising log integration. - [Monitoring: Prometheus Exporter Integration](https://docs.aiderx.io/development/en/prometheus-exporter-monitoring.md) - [Serving ADs](https://docs.aiderx.io/development/en/serving-ad.md): Serving ADs with A2 - [System Error Resolution Guide](https://docs.aiderx.io/development/en/troubleshooting.md): Detailed explanation of troubleshooting methods for various errors occurring in the A2 system. - [Campaign creation and publication request processing by api](https://docs.aiderx.io/development/tutorial/en/campaign-management.md): Describes how to create campaigns and handle approval requests by API - [How to get access token for api usage](https://docs.aiderx.io/development/tutorial/en/get-token.md): Describes how to get the access tokens you need to use A2's APIs. - [Ads Integration with SDK](https://docs.aiderx.io/development/tutorial/en/sdk-usage.md): This guide introduces methods for requesting ads and advertising log integration. - [A2: Aider for Advertising](https://docs.aiderx.io/guides/about-a2/en/a2-introduction.md) - [A2 OnPrem](https://docs.aiderx.io/guides/about-a2/en/a2-vs-saas-vs-inhouse.md): Comparing A2, SaaS, and in-house development. - [Account & Budget](https://docs.aiderx.io/guides/about-a2/en/account-and-budget.md): Detailed guide on account types and budget allocation. - [Allocation](https://docs.aiderx.io/guides/about-a2/en/allocation.md): Introduction to Allocation - [Audience Targeting](https://docs.aiderx.io/guides/about-a2/en/audience-targeting.md): Audience Targeting Guide - [Campaign](https://docs.aiderx.io/guides/about-a2/en/campaign.md): Introduction to Campaign - [Creative](https://docs.aiderx.io/guides/about-a2/en/creative.md): Introduction to Creative - [First-Party Data](https://docs.aiderx.io/guides/about-a2/en/first-party-data.md): A2 advertising platform precisely measures advertising performance based on first-party data and automatically optimizes targeting and bidding strategies. - [Media Library](https://docs.aiderx.io/guides/about-a2/en/media-library.md): The media library feature is introduced here. - [Placement](https://docs.aiderx.io/guides/about-a2/en/placement.md): Introduction to Placement - [Features & Benefits](https://docs.aiderx.io/guides/about-a2/en/why-a2.md): Introducing A2's Features and Benefits - [A2 Cloud](https://docs.aiderx.io/guides/about-a2/en/why-a2-cloud.md): Introducing A2 Cloud's Features and Benefits - [Yield Optimization Settings](https://docs.aiderx.io/guides/about-a2/en/yield-optimization.md): This section describes the retailer’s Revenue Optimization settings. - [FAQ](https://docs.aiderx.io/guides/get-started/en/a2-faq.md): This document is an FAQ (Frequently Asked Questions) that compiles common questions about A2 and their answers. - [A2: Basic Usage](https://docs.aiderx.io/guides/get-started/en/basic-usage.md): This guide is designed to help you quickly and accurately follow the key steps in setting up an image banner advertisement using A2 and displaying it on an ad placement. - [A2: Preparation](https://docs.aiderx.io/guides/get-started/en/preparation.md): Getting Started with A2 ## OpenAPI Specs - [decision.api.ko-0.2.2](https://docs.aiderx.io/openapi/decision.api.ko-0.2.2.json) - [decision.api.en-0.2.2](https://docs.aiderx.io/openapi/decision.api.en-0.2.2.json) - [adm.openapi.ko-0.2.2](https://docs.aiderx.io/openapi/adm.openapi.ko-0.2.2.json) - [adm.openapi.en-0.2.2](https://docs.aiderx.io/openapi/adm.openapi.en-0.2.2.json) ## Optional - [Support](mailto:a2support@aiderx.io) - [Blog](https://aiderx.io/blog) - [고객 지원](mailto:a2support@aiderx.io) - [블로그](https://aiderx.io/ko/blog)