> ## Documentation Index
> Fetch the complete documentation index at: https://docs.interchange.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Configure AXE custom-targeting key names

> Declare which GAM custom-targeting key names carry Scope3 include, exclude, and emissions-macro targeting on a Google Ad Manager-backed ad server source. `axeMacroKey` MUST equal literally "axem" — the GAM creative macro %%PATTERN:axem%% only resolves against that exact key name; a rename silently breaks emissions attribution. All three names must already exist as FREEFORM keys in the source's synced GAM custom-targeting catalog; unknown names are rejected with the list of missing keys.



## OpenAPI

````yaml /v2/storefront-api-v2.yaml put /esa/{esaId}/axe-keys
openapi: 3.0.0
info:
  title: Scope3 Storefront API
  version: 2.0.0
  description: |-
    REST API for partners to manage storefronts, inventory sources, and billing.

    ## Authentication

    All endpoints require a Bearer token in the Authorization header:
    ```
    Authorization: Bearer your-api-key
    ```

    ## Base URL

    `https://api.interchange.io/api/v2/storefront`

    ## For AI Agents

    AI agents can use the MCP endpoint at `/mcp/v2/storefront` with three tools:
    - `initialize`: Start an MCP session
    - `api_call`: Make REST API calls
    - `ask_about_capability`: Learn about API features
servers:
  - url: https://api.interchange.io/api/v2/storefront
    description: Production server
security: []
tags:
  - name: Account
    description: Account management, service tokens, and preferences
  - name: Storefront
    description: Manage storefront and inventory sources
  - name: Storefront Agents
    description: List and manage registered sales, signals, and outcomes agents
  - name: Storefront Activity
    description: Audit log of configuration and inventory changes on the storefront
  - name: Storefront Billing
    description: Payout bank details and billing configuration for storefronts
  - name: AI Usage
    description: Storefront AI token usage visibility by model
  - name: MCP
    description: Model Context Protocol endpoints
paths:
  /esa/{esaId}/axe-keys:
    put:
      tags:
        - Storefront Ad Server Buyer Routing
      summary: Configure AXE custom-targeting key names
      description: >-
        Declare which GAM custom-targeting key names carry Scope3 include,
        exclude, and emissions-macro targeting on a Google Ad Manager-backed ad
        server source. `axeMacroKey` MUST equal literally "axem" — the GAM
        creative macro %%PATTERN:axem%% only resolves against that exact key
        name; a rename silently breaks emissions attribution. All three names
        must already exist as FREEFORM keys in the source's synced GAM
        custom-targeting catalog; unknown names are rejected with the list of
        missing keys.
      operationId: configureEsaAxeKeys
      parameters:
        - in: path
          name: esaId
          schema:
            description: >-
              Ad server source connection id. The wire field remains `esaId` for
              API compatibility.
            example: 123
            type: integer
            maximum: 9007199254740991
            minimum: 1
          required: true
          description: >-
            Ad server source connection id. The wire field remains `esaId` for
            API compatibility.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigureAxeKeysBody'
      responses:
        '200':
          description: Configure AXE custom-targeting key names
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigureAxeKeysResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: >-
            One or more key names are not present in the source's synced GAM
            custom-targeting catalog. The error body includes a `missing` array
            naming the absent keys. Ensure they exist in GAM (Admin → Custom
            Targeting) as FREEFORM keys, refresh the ad server source, and
            retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    ConfigureAxeKeysBody:
      type: object
      properties:
        axeIncludeKey:
          type: string
          minLength: 1
        axeExcludeKey:
          type: string
          minLength: 1
        axeMacroKey:
          type: string
          enum:
            - axem
      required:
        - axeIncludeKey
        - axeExcludeKey
        - axeMacroKey
    ConfigureAxeKeysResponse:
      type: object
      properties:
        setupTask:
          $ref: '#/components/schemas/AxeKeysSetupTask'
      required:
        - setupTask
      additionalProperties: false
    ErrorResponse:
      description: Standard error response
      type: object
      properties:
        data:
          type: string
          nullable: true
          enum:
            - null
        error:
          $ref: '#/components/schemas/ApiError'
      required:
        - data
        - error
      additionalProperties: false
    AxeKeysSetupTask:
      type: object
      properties:
        key:
          type: string
        name:
          type: string
        description:
          type: string
        isComplete:
          type: boolean
        actionUrl:
          nullable: true
          type: string
        details:
          nullable: true
          type: string
      required:
        - key
        - name
        - isComplete
      additionalProperties: false
    ApiError:
      description: Structured error object
      type: object
      properties:
        code:
          description: Machine-readable error code
          type: string
        message:
          description: Human-readable error message
          type: string
        field:
          description: Field path associated with the error
          type: string
        details:
          description: Additional error context
          type: object
          additionalProperties: {}
      required:
        - code
        - message
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key or access token

````