SmartNews insights API

The insights API from SmartNews — 2 operation(s) for insights.

OpenAPI Specification

smartnews-insights-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  version: 3.0.1
  title: SmartNews Marketing ad insights API
  description: "# Previous Versions\n- SmartNews Marketing API (2.0.0): https://ads.smartnews.com/developers/deprecated/v2/index.html\n  - **API v2 has been fully disabled.** All requests to `api/ma/v2/*` endpoints now return a `410 Gone` error. Please ensure that your system has been updated to use API v3. See [How to Upgrade From Marketing API v2 to v3](#section/How-to-Upgrade-From-Marketing-API-v2-to-v3).\n\n# About This Document\nThis document provides the API specifications for the Ads Management system on the SmartNews Ads Platform. It is intended for developers who use the API to automate advertising operations.\n\nTo use the SmartNews Ads API, you must agree to the SmartNews Ads API Terms of Service.\n\n- **English Version:** https://ads.smartnews.com/developers/tos-en.html\n- **Japanese Reference Translation:** https://ads.smartnews.com/developers/tos-ja.html\n# Contact Information\n\nAPI Help Page:\n- (Ja) https://help-ads.smartnews.com/item-4207/\n- (En) https://help-ads.smartnews.com/linkonly/item-4442/\n\n**For inquiries:**\n\nFor the Japan region\n\nPlease contact us through the following link:\nhttps://smartnews-ads.zendesk.com/hc/ja/requests/new?ticket_form_id=&u=1723081408\n\n- **カテゴリ:** Select \"Standard Adsに関するお問い合わせ\"\n- **該当の項目:** Select \"APIの仕様・不具合について\"\n- **対象のAPI:** Select \"Marketing API\"\n\nFor the US region\n\nPlease contact us through the following link:\nhttps://business.smartnews.com/get-started-ads\n\n# Change Log\n\nJanuary 2026\n- Released Marketing API v3 version which requires pagination parameters for insights and list campaign/adgroup/ad endpoints.\n  - See [How to Upgrade From Marketing API v2 to v3](#section/How-to-Upgrade-From-Marketing-API-v2-to-v3)\n  - To access the old docs, visit https://ads.smartnews.com/developers/deprecated/v2/index.html\n  - API v2 will be sunset on June 30, 2026 (JST). Please ensure that your system is updated to use API v3 by that date.\n- CSV format is now supported for insights v3.\n\nApril 2026\n- (catalog) Added new APIs for catalogs and productSets which are available for certain allowlisted developer app only.\n  - In order to access the API, one developer app should be created with access to the adAccount for campaign management.\n  - Please contact Customer Support with the developer app and business details to request access to the Catalog APIs.\n\nMay 2026\n- Added rate limit for OAuth token issuance endpoint (`generateAccessToken`): 5 requests per minute per developer app. Access tokens are valid for 24 hours and should be reused within that period.\n- Added new `channel_alias_labels` endpoint to retrieve channel alias label options for ad group targeting.\n- Increased the maximum `spending_limit_micro` for JP ad accounts from 1,000,000,000,000,000 to 10,000,000,000,000,000.\n\nJuly 2026\n- **API v2 has been fully disabled.** All requests to `api/ma/v2/*` endpoints now return a `410 Gone` error. If you have not yet migrated, please update your system to use API v3. See [How to Upgrade From Marketing API v2 to v3](#section/How-to-Upgrade-From-Marketing-API-v2-to-v3).\n\n# How to Upgrade From Marketing API v2 to v3\n- **Note: API v2 is now fully disabled. Any request to an `api/ma/v2/*` endpoint will return a `410 Gone` error. You must migrate to the equivalent `api/ma/v3/*` endpoint.**\n- The main change is pagination; affected endpoints are as follows:\n  - `/api/ma/v3/ad_accounts/{ad_account_id}/insights/{layer}`\n  - `/api/ma/v3/ad_accounts/{ad_account_id}/campaigns`\n  - `/api/ma/v3/ad_accounts/{ad_account_id}/campaigns/{campaign_id}/ad_groups`\n  - `/api/ma/v3/ad_accounts/{ad_account_id}/ad_groups`\n  - `/api/ma/v3/ad_accounts/{ad_account_id}/ad_groups/{ad_group_id}/ads`\n  - `/api/ma/v3/ad_accounts/{ad_account_id}/ads`\n- For the above endpoints, `page_size` and `page` query parameters are added with default values.\n- The full list of objects for an account can no longer be retrieved by a single request if the number of objects exceeds the maximum `page_size` (differs per endpoint, please check endpoint documentation for details).\n- Newly added `pagination` object in response provides the total number of available objects and pages. Please use this information to fetch all pages as required.\n- For CSV, we recommend setting `remove_csv_header=true` for pages greater than 1. This allows you to easily join all pages to create the full CSV file.\n  - CSV does not include the pagination summary. Please keep calling the endpoint until there are no rows returned in the response.\n\n# Base URL\nThe base URL for all API requests is `https://ads.smartnews.com/`.\n\nFor example, to call the GET Campaign endpoint, the request URL will be `https://ads.smartnews.com/api/ma/v3/ad_accounts/{ad_account_id}/campaigns/`\n\n# Rate Limit\nRequests are limited per developer app ID. Making too many requests in a short time will result in a 429 error.\n\nIn this case, please wait a short time and retry the request again.\n\nCurrently the limits are as follows:\n\n- 10 GET requests per second\n- 10 POST/PATCH/DELETE requests per second\n- 5 OAuth token requests per minute (generateAccessToken endpoint)\n  - Access tokens are valid for 24 hours. Please reuse the same token for multiple API requests within its validity period, rather than generating a new token for each request.\n\nNote: we do not guarantee these limits and they are subject to change, so we strongly recommend not relying on these limits but instead implementing retry logic\nbased on 429 error response.\n\n# Authentication / Authorization\nTo set the JWT token in the HTTP header based on the provided OpenAPI definition, please include the Authorization header with the following format:\n```\nAuthorization: Bearer <access token>\n```\nAccess tokens are generated using the OAuth API. Please refer to the [OAuth API](#tag/oauth) for more information.\n\n# About Currency Units\n\nThe SmartNews Ads Marketing API uses the `_micro` notation for monetary amounts, representing currency values as integers.\nExamples include `daily_budget_amount_micro` and `bid_amount_micro` in campaign level.\n\nThis integer representation multiplies the actual currency amount by 1,000,000.\n\nExamples:\n\n| Currency | API notation (micro) | Actual amount |\n-----------|----------------------|---------------|\n| USD      | 1,500,000            | $1.50 USD     |\n| USD      | 2,500,000            | $2.50 USD     |\n| JPY      | 5,000,000            | ¥5 JPY        |\n| JPY      | 120,000,000          | ¥120 JPY      |\n\nIn practice, when specifying monetary amounts via the API, you should use an integer value equal to 1,000,000 times the intended actual amount.\n\nAvailable currencies are set at the advertising account level.\n\n# Simultaneous Update Operation Limitation\n\nThe following applies to Campaign, AdGroup, Ad `POST`, `PATCH` and `DELETE` endpoints:\n\nThere are limitations on doing simultaneous operations on related objects (\"simultaneous\" means starting a second request before receiving a response from the first request).\n\nThe following cases are not allowed and will result in a `409 Conflict` error:\n\n- __Creating, updating or deleting multiple children of the same parent simultaneously.__\n  - Example 1: Updating two Ads which both belong to the same Campaign at the same time.\n  - Example 2: Creating an Ad and deleting another Ad which both belong to the same Campaign.\n  - Example 3: Creating two AdGroups which both belong to the same Campaign.\n  - Example 4: Creating an AdGroup and an Ad which both belong to the same Campaign.\n- __Creating, updating or deleting objects at the same time as its parent object.__\n  - Example 1: Updating a Campaign and its child AdGroup at the same time.\n  - Example 2: Updating an AdGroup and deleting one of its Ads at the same time.\n"
  contact:
    name: SmartNews Ads Support
servers:
- url: https://ads.smartnews.com
  description: Production
security:
- ApiKeyAuth: []
tags:
- name: insights
paths:
  /api/ma/v3/ad_accounts/{ad_account_id}/insights/{layer}:
    get:
      tags:
      - insights
      description: 'Get a list of metadata and metrics information for objects matching the query for the specified layer (Campaign/AdGroup/Ad).


        The fields to include in the response must be specified by the API caller, using the `fields` parameter.


        Note: Only Ads Manager v2 objects can be retrieved by this API.


        Both JSON (`application/json`) and CSV (`text/csv`) response formats are supported. Use the `Accept` header to specify the desired format.

        '
      operationId: getInsightsV3
      summary: Insights
      parameters:
      - name: Accept-Language
        in: header
        schema:
          $ref: '#/components/schemas/AcceptLanguage'
      - name: ad_account_id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: layer
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/Layer'
      - name: since
        required: true
        example: '2024-08-15T15:00:00Z'
        description: 'Only include metrics from this datetime (inclusive).


          It must be specified in ISO 8601 format with UTC timezone (ends with `Z`).

          '
        in: query
        schema:
          type: string
          format: date-time
      - name: until
        example: '2024-08-15T15:00:00Z'
        description: 'Only include metrics until this datetime (inclusive).


          It must be specified in ISO 8601 format with UTC timezone (ends with `Z`).

          '
        in: query
        schema:
          type: string
          format: date-time
      - name: fields
        required: true
        description: 'The fields to include in the response. For a detailed description of each field, see the response section under `metadata` or `metrics`.


          The prefix indicates whether the field will be present in the `metadata` or `metrics` object of the response.


          - Starts with `metadata_`: Is a `metadata` field.

          - Starts with `metrics_`: Is a `metrics` field.


          * `metrics_reach` and `metrics_frequency` are not currently supported


          ### Layer Specific Metadata fields


          #### Campaign

          - `metadata_objective`

          - `metadata_daily_budget_amount`

          - `metadata_start_date_time`

          - `metadata_end_date_time`

          - `metadata_optimization_event`

          - `metadata_optimization_goal`

          - `metadata_spending_limit`


          #### Ad Group

          - `metadata_campaign_id`

          - `metadata_campaign_name`


          #### Ad

          - `metadata_campaign_id`

          - `metadata_campaign_name`

          - `metadata_ad_group_id`

          - `metadata_ad_group_name`

          - `metadata_submission_status`

          - `metadata_moderation_status`

          - `metadata_thumbnails`

          - `metadata_video`

          - `metadata_ad_headline`

          - `metadata_ad_description`

          - `metadata_ad_creative_format`

          '
        in: query
        schema:
          type: array
          items:
            $ref: '#/components/schemas/FieldV3'
      - name: breakdown_type
        in: query
        description: "When specified, the report is broken down by the specified audience breakdown type. The breakdown can be found inside the `metrics_breakdown` field in the response. \n\n**When included in a JSON request, the following restrictions apply:**\n- cannot use the `city`, `county`, `os`, `device_type` or `hyper_location_segment` breakdowns.\n- cannot use `breakdown_type` together with `breakdown_period`.\n"
        schema:
          $ref: '#/components/schemas/BreakdownType'
      - name: breakdown_period
        in: query
        description: "The time period to breakdown the report by. The breakdown can be found inside the `metrics_breakdown` field in the response. \n\nThis option combines with the `breakdown_type` param. For example `breakdown_type=age&breakdown_period=day` \nresults in one breakdown row for each day and age combination within the specified date range.\n\n**When included in a JSON request, the following restrictions apply:**\n- When using `hour` breakdown period, 1-5 object IDs must be specified using the `target_ids` parameter.\n- cannot use `breakdown_type` together with `breakdown_period`.\n"
        schema:
          $ref: '#/components/schemas/BreakdownPeriod'
      - name: include_deleted
        in: query
        required: false
        description: Boolean flag for including deleted objects in the response.
        schema:
          $ref: '#/components/schemas/IncludeDeleted'
      - name: mobile_app_attribution_mode
        in: query
        description: 'The mobile app attribution mode for counting conversions of app campaigns only. The mobile app attribution mode will not be applied for web campaigns.


          There are two modes: `all` and `mmp_only`.


          `all` mode counts all app campaigns'' conversions including those attributed by a Mobile Measurement Partner and SmartNews attribution.

          `mmp_only` mode only counts app campaigns'' conversions attributed by a Mobile Measurement Partner.

          '
        schema:
          $ref: '#/components/schemas/MobileAppAttributionMode'
      - name: click_attribution_window
        in: query
        description: 'The attribution window for counting conversions.


          Calculate the conversions that occur within the specified time window after a click.


          The default value is 30 days.

          '
        schema:
          $ref: '#/components/schemas/ClickAttributionWindow'
      - name: vimp_attribution_window
        in: query
        description: 'The attribution window for counting conversions.


          Calculate the conversions that occur within the specified time window after a viewable impression.


          The default value is 1 day.

          '
        schema:
          $ref: '#/components/schemas/VimpAttributionWindow'
      - name: target_ids
        in: query
        description: 'Filter by target id(s) (campaign_id for Campaign, ad_group_id for AdGroup, ad_id for Ad)

          Only the ad object id of the specified layer (determined by the `layer` in the path) is supported.


          **When included in a JSON request, this field is required when either of  the following parameters is specified:**

          - breakdown_type

          - breakdown_period


          Note: when `breakdown_period` is `hour`, the maximum size of `target_ids` is 5, not 100.

          '
        schema:
          type: array
          minItems: 1
          maxItems: 100
          items:
            type: integer
            format: int64
        style: form
        explode: false
        example:
        - 1
        - 2
        - 3
      - name: page_size
        in: query
        required: false
        schema:
          example: 100
          type: integer
          minimum: 1
          maximum: 100
        description: 'The number of objects to return per page.


          The maximum page size is 100.

          '
      - name: page
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Page'
      - name: sort
        in: query
        required: false
        description: "Specify an array of fields and orders to sort the response by. The format of each item is `{field}:{order}`.\n\nIf not specified, the default sort order is by `id` descending.\n\nOrder must be either `asc` or `desc`.\n\nFor available values of `field`, see the `SortableField` enum, which includes:\n\n- Sortable Metadata fields:\n  - `metadata_configured_status`\n  - `metadata_name`\n  - `metadata_start_date_time`\n  - `metadata_end_date_time`\n  - `metadata_objective`\n  - `metadata_daily_budget_amount`\n  - `metadata_spending_limit`\n  - `metadata_submission_status`\n  - `metadata_moderation_status`\n  - `metadata_campaign_name`\n  - `metadata_ad_group_name`\n- Sortable Metrics fields:\n  - All fields starting with `metrics_` are available for sorting, except for:\n    - `metrics_reach`\n    - `metrics_frequency`\n    - `metrics_spent_before_this_month`\n    - `metrics_lifetime_spent`\n"
        schema:
          type: array
          items:
            $ref: '#/components/schemas/SortParameter'
          minItems: 1
          maxItems: 2
        style: form
        explode: false
        example:
        - metrics_click:desc
        - metadata_name:asc
      - name: search
        in: query
        schema:
          example: My Campaign Name
          type: string
          minLength: 1
          maxLength: 256
        description: 'Filter by objects in the specified layer whose name or ID contains the search query.

          '
      - name: parent_ids
        in: query
        schema:
          type: array
          items:
            type: integer
            format: int64
          minItems: 1
          maxItems: 100
        style: form
        explode: false
        example:
        - 1
        - 2
        - 3
        description: 'Only available when `layer` is `ad_groups` or `ads`.


          A comma separated list of parent IDs to filter the result by.


          In `ad_groups` layer, it represents the `campaign_id` of the campaign(s) which own the ad groups.

          In `ads` layer, it represents the `ad_group_id` of the ad group(s) which own the ads.

          '
      - name: remove_csv_header
        in: query
        required: false
        schema:
          type: boolean
          default: false
        description: 'Only applicable when the `Accept` header is `text/csv`.


          When set to `true`, the CSV header row is omitted from the response.


          This is recommended when joining multiple CSV responses together, to avoid duplicate header rows.

          '
      responses:
        '200':
          description: 'Returns insights data in the requested format (JSON or CSV).

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsightsResponseV3'
            text/csv:
              schema:
                type: string
                description: CSV formatted insights data.
        '400':
          description: 'Bad request, required query parameter is not found. (ie: metrics_fields)'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorResponse'
        '401':
          description: Unauthorized. The access token is either expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorResponse'
              x-examples:
                expiredToken:
                  summary: Access token has expired.
                  value:
                    error:
                      type: UNAUTHORIZED
                      message: Token has expired.
                      retriable: false
                invalidToken:
                  summary: Access token is invalid.
                  value:
                    error:
                      type: UNAUTHORIZED
                      message: Token is invalid.
                      retriable: false
        '403':
          description: Forbidden. Access to the requested resource is denied.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorResponse'
              examples:
                terms_of_service_not_accepted:
                  summary: User has not accepted the terms of service.
                  value:
                    error:
                      type: TERMS_OF_SERVICE_NOT_ACCEPTED
                      message: The owner of the assets must accept the Ads terms of service.
                      terms_of_service_path: /terms/agreement
                      retriable: false
                access_denied:
                  summary: Access is denied due to insufficient permissions.
                  value:
                    error:
                      type: ACCESS_DENIED
                      message: Access denied.
                      retriable: false
        '404':
          description: When the resource specified in the query is not found or the user doesn't have permission to access the resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundErrorResponse'
        '406':
          description: Not Acceptable. The requested format is not supported.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotAcceptableErrorResponse'
        '429':
          description: Too many requests were made within a short period. Wait a while and try again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitedErrorResponse'
        '500':
          description: Unexpected error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnexpectedErrorResponse'
        '503':
          description: The service is temporarily unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableErrorResponse'
  /api/ma/v3/ad_accounts/{ad_account_id}/aggregated_insights/{layer}:
    get:
      tags:
      - insights
      description: 'Get aggregated metrics information for objects matching the query for the specified layer (Campaign/AdGroup/Ad).


        The fields to include in the response must be specified by the API caller, using the `fields` parameter.


        Note: Only Ads Manager v2 metrics can be retrieved by this API.

        '
      operationId: getAggregatedInsightsV3
      summary: Aggregated Insights
      parameters:
      - name: Accept-Language
        in: header
        schema:
          $ref: '#/components/schemas/AcceptLanguage'
      - name: ad_account_id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: layer
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/Layer'
      - name: since
        required: true
        example: '2024-08-15T15:00:00Z'
        description: 'Only include metrics from this datetime (inclusive).


          It must be specified in ISO 8601 format with UTC timezone (ends with `Z`).

          '
        in: query
        schema:
          type: string
          format: date-time
      - name: until
        example: '2024-08-15T15:00:00Z'
        description: 'Only include metrics until this datetime (inclusive).


          It must be specified in ISO 8601 format with UTC timezone (ends with `Z`).

          '
        in: query
        schema:
          type: string
          format: date-time
      - name: fields
        description: 'The fields to include in the response. For a detailed description of each field, see the response section under `metrics`.


          Note: only fields beginning with `metrics_` are supported for aggregated insights.

          '
        in: query
        schema:
          type: array
          items:
            $ref: '#/components/schemas/FieldV3'
      - name: include_deleted
        in: query
        required: false
        description: Boolean flag for including deleted objects in the response.
        schema:
          $ref: '#/components/schemas/IncludeDeleted'
      - name: mobile_app_attribution_mode
        in: query
        description: 'The mobile app attribution mode for counting conversions of app campaigns only. The mobile app attribution mode will not be applied for web campaigns.


          There are two modes: `all` and `mmp_only`:


          - `all` mode counts all app campaigns'' conversions including those attributed by a Mobile Measurement Partner and SmartNews attribution.

          - `mmp_only` mode only counts app campaigns'' conversions attributed by a Mobile Measurement Partner.

          '
        schema:
          $ref: '#/components/schemas/MobileAppAttributionMode'
      - name: click_attribution_window
        in: query
        description: 'The attribution window for counting conversions.


          Calculate the conversions that occur within the specified time window after a click.


          The default value is 30 days.

          '
        schema:
          $ref: '#/components/schemas/ClickAttributionWindow'
      - name: vimp_attribution_window
        in: query
        description: 'The attribution window for counting conversions.


          Calculate the conversions that occur within the specified time window after a viewable impression.


          The default value is 1 day.

          '
        schema:
          $ref: '#/components/schemas/VimpAttributionWindow'
      - name: target_ids
        in: query
        description: 'Filter by target id(s) (campaign_id for Campaign, ad_group_id for AdGroup, ad_id for Ad)

          Only the ad object id of the specified layer (determined by the `layer` in the path) is supported.

          '
        schema:
          type: array
          items:
            type: integer
            format: int64
      - name: breakdown_period
        in: query
        description: 'The time period to breakdown the report by. The breakdown can be found inside the `metrics_breakdown` field in the response.

          '
        schema:
          $ref: '#/components/schemas/BreakdownPeriod'
      - name: breakdown_type
        in: query
        description: 'When specified, the report is broken down by the specified audience breakdown type. The breakdown can be found inside the `metrics_breakdown` field in the response.

          '
        schema:
          $ref: '#/components/schemas/AggregatedInsightsBreakdownType'
      responses:
        '200':
          description: An object of aggregated insights data of a specific object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AggregatedInsightsResponseV3'
        '400':
          description: 'Bad request, required query parameter is not found. (ie: metrics_fields)'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorResponse'
        '401':
          description: Unauthorized. The access token is either expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorResponse'
              x-examples:
                expiredToken:
                  summary: Access token has expired.
                  value:
                    error:
                      type: UNAUTHORIZED
                      message: Token has expired.
                      retriable: false
                invalidToken:
                  summary: Access token is invalid.
                  value:
                    error:
                      type: UNAUTHORIZED
                      message: Token is invalid.
                      retriable: false
        '403':
          description: Forbidden. Access to the requested resource is denied.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorResponse'
              examples:
                terms_of_service_not_accepted:
                  summary: User has not accepted the terms of service.
                  value:
                    error:
                      type: TERMS_OF_SERVICE_NOT_ACCEPTED
                      message: The owner of the assets must accept the Ads terms of service.
                      terms_of_service_path: /terms/agreement
                      retriable: false
                access_denied:
                  summary: Access is denied due to insufficient permissions.
                  value:
                    error:
                      type: ACCESS_DENIED
                      message: Access denied.
                      retriable: false
        '404':
          description: When the resource specified in the query is not found or the user doesn't have permission to access the resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundErrorResponse'
        '406':
          description: Not Acceptable. The requested format is not supported.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotAcceptableErrorResponse'
        '429':
          description: Too many requests were made within a short period. Wait a while and try again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitedErrorResponse'
        '500':
          description: Unexpected error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnexpectedErrorResponse'
        '503':
          description: The service is temporarily unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableErrorResponse'
components:
  schemas:
    ObjectType:
      type: string
      enum:
      - CAMPAIGN
      - AD_GROUP
      - AD
      description: The type of object.
    NotAcceptableErrorExtension:
      type: object
      required:
      - type
      properties:
        type:
          type: string
          enum:
          - NOT_ACCEPTABLE
    DeliveryStatus:
      type: string
      enum:
      - DELETED
      - PAUSED
      - NOT_ELIGIBLE
      - PENDING
      - ENDED
      - ELIGIBLE
      - UNKNOWN
      - DISABLED
      description: 'The delivery status of the object determined by the system.


        | Delivery status | What it means |

        |-----------------|---------------|

        | DELETED         | The object is deleted by an ad operator |

        | PAUSED          | The object is paused by an ad operator  |

        | NOT_ELIGIBLE    | The object is configured to be active but is not delivered due to some conditions. Please check the `reason` or `description` field for more details |

        | PENDING         | The object is configured to be active and will be delivered when certain conditions are met. Please check Please check the `reason` or `description` field for more details |

        | ENDED           | The object is configured to be active but the campaign has ended |

        | ELIGIBLE        | The object is configured to be active and is delivering ads |

        | UNKNOWN         | The object is configured to be active but its delivery status is unknown |

        | DISABLED        | The object is disabled because the business, account, or brand is disabled|

        '
    StoreSetId:
      type: integer
      format: int64
      description: 'Identifier of the store set associated with this campaign for Store Visit measurement.

        Store sets are managed under Business Management.

        '
    IncludeDeleted:
      type: boolean
      default: false
    InsightsResponseV3:
      type: object
      required:
      - data
      - pagination
      properties:
        data:
          description: An array of objects containing fields for each ad object.
          type: array
          items:
            $ref: '#/components/schemas/StandardInsightsItemV3'
        pagination:
          $ref: '#/components/schemas/PaginationInfoResponse'
    AdThumbnail:
      type: object
      required:
      - aspect_ratio_type
      - url
      properties:
        aspect_ratio_type:
          $ref: '#/components/schemas/AspectRatioType'
        url:
          $ref: '#/components/schemas/Url'
    AcceptLanguage:
      type: string
      description: 'The language to use for system generated text within API responses.


        The currently supported languages are English (`en`, `en-*`) and Japanese (`ja`, `ja-JP`)

        '
      example: en-US
    StandardInsightsItemV3:
      type: object
      required:
      - type
      - id
      properties:
        type:
          $ref: '#/components/schemas/Ob

# --- truncated at 32 KB (79 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/smartnews/refs/heads/main/openapi/smartnews-insights-api-openapi.yml