airbyte/airbyte-integrations/connectors/source-amazon-ads/source_amazon_ads/spec.yaml

---
documentationUrl: https://docs.airbyte.com/integrations/sources/amazon-ads
connectionSpecification:
  title: Amazon Ads Spec
  type: object
  properties:
    auth_type:
      title: Auth Type
      const: oauth2.0
      order: 0
      type: string
    client_id:
      title: Client ID
      description:
        The client ID of your Amazon Ads developer application. See the
        <a href="https://advertising.amazon.com/API/docs/en-us/get-started/generate-api-tokens#retrieve-your-client-id-and-client-secret">docs</a>
        for more information.
      order: 1
      type: string
    client_secret:
      title: Client Secret
      description:
        The client secret of your Amazon Ads developer application. See
        the <a href="https://advertising.amazon.com/API/docs/en-us/get-started/generate-api-tokens#retrieve-your-client-id-and-client-secret">docs</a>
        for more information.
      airbyte_secret: true
      order: 2
      type: string
    refresh_token:
      title: Refresh Token
      description:
        Amazon Ads refresh token. See the <a href="https://advertising.amazon.com/API/docs/en-us/get-started/generate-api-tokens">docs</a>
        for more information on how to obtain this token.
      airbyte_secret: true
      order: 3
      type: string
    region:
      title: Region
      description:
        Region to pull data from (EU/NA/FE). See <a href="https://advertising.amazon.com/API/docs/en-us/info/api-overview#api-endpoints">docs</a>
        for more details.
      enum:
        - NA
        - EU
        - FE
      type: string
      default: NA
      order: 4
    start_date:
      title: Start Date
      description:
        The Start date for collecting reports, should not be more than
        60 days in the past. In YYYY-MM-DD format
      examples:
        - "2022-10-10"
        - "2022-10-22"
      order: 5
      type: string
    profiles:
      title: Profile IDs
      description:
        Profile IDs you want to fetch data for. See <a href="https://advertising.amazon.com/API/docs/en-us/concepts/authorization/profiles">docs</a>
        for more details.
      order: 6
      type: array
      items:
        type: integer
    state_filter:
      title: State Filter
      description: Reflects the state of the Display, Product, and Brand Campaign streams as enabled, paused, or archived. If you do not populate this field, it will be ignored completely.
      items:
        type: string
        enum:
          - enabled
          - paused
          - archived
      type: array
      uniqueItems: true
      order: 7
    look_back_window:
      title: "Look Back Window"
      description: "The amount of days to go back in time to get the updated data from Amazon Ads"
      examples:
      - 3
      - 10
      type: "integer"
      default: 3
      order: 8
    report_record_types:
      title: Report Record Types
      description:
        Optional configuration which accepts an array of string of record types.
        Leave blank for default behaviour to pull all report types.
        Use this config option only if you want to pull specific report type(s).
        See <a href="https://advertising.amazon.com/API/docs/en-us/reporting/v2/report-types">docs</a>
        for more details
      items:
        type: string
        enum:
          - adGroups
          - asins
          - asins_keywords
          - asins_targets
          - campaigns
          - keywords
          - productAds
          - targets
      type: array
      uniqueItems: true
      order: 9
  required:
    - client_id
    - client_secret
    - refresh_token
  additionalProperties: true
advanced_auth:
  auth_flow_type: oauth2.0
  predicate_key:
    - auth_type
  predicate_value: oauth2.0
  oauth_config_specification:
    complete_oauth_output_specification:
      type: object
      additionalProperties: true
      properties:
        refresh_token:
          type: string
          path_in_connector_config:
            - refresh_token
    complete_oauth_server_input_specification:
      type: object
      additionalProperties: true
      properties:
        client_id:
          type: string
        client_secret:
          type: string
    complete_oauth_server_output_specification:
      type: object
      additionalProperties: true
      properties:
        client_id:
          type: string
          path_in_connector_config:
            - client_id
        client_secret:
          type: string
          path_in_connector_config:
            - client_secret