PPC Ads Competitive Intelligence · Actions GPT

{
  "openapi": "3.1.0",
  "info": {
    "title": "Adzviser Actions for GPT",
    "description": "Equip GPTs with the ability to retrieve advertisers' ads history from both Google Transparent Center and Facebook Ad Library at a time.",
    "version": "v0.0.1"
  },
  "servers": [
    {
      "url": "https://copter.adzviser.com"
    }
  ],
  "paths": {
    "/google_ads_transparency_countries": {
      "get": {
        "description": "Get the list of seletable countries/regions to retrieve ads history from Google Ads Transparency Center.",
        "operationId": "getGoogleAdsTransparencyCountries",
        "parameters": [],
        "deprecated": false,
        "security": [],
        "x-openai-isConsequential": false
      }
    },
    "/fb_ad_lib_countries": {
      "get": {
        "description": "Get the list of seletable countries/regions to retrieve ads history from Facebook Ad Library.",
        "operationId": "getFacebookAdLibraryCountries",
        "parameters": [],
        "deprecated": false,
        "security": [],
        "x-openai-isConsequential": false
      }
    },
    "/competitor_ppc_ads_history": {
      "post": {
        "description": "Retrieve combined ads history from an advertiser based on a keyword, such as advertiser's name, from Google Ads and Facebook Ads",
        "operationId": "getCompetitorPpcAdsHistory",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ppcAdsHistoryRequest"
              }
            }
          },
          "required": true
        },
        "deprecated": false,
        "security": [
          {
            "oauth2": []
          }
        ],
        "x-openai-isConsequential": false
      }
    }
  },
  "components": {
    "schemas": {
      "ppcAdsHistoryRequest": {
        "description": "Contains details about queried countries, keyword and date range",
        "type": "object",
        "required": [
          "keyword"
        ],
        "title": "ppcAdsHistoryRequest",
        "properties": {
          "keyword": {
            "type": "string",
            "title": "keyword",
            "description": "For example, if the user asks for \"ads history for amazon\", then the keyword in this case will be \"amazon\"; if the user asks for \"ads history for reddit.com\", then keyword in this case should be \"reddit.com\""
          },
          "date_range": {
            "type": "array",
            "description": "A 2-element array. The first represents the start date and the second the end date. Both are in YYYY-MM-DD format.",
            "items": {
              "type": "string"
            }
          },
          "fb_regions": {
            "type": "array",
            "description": "If the user specifies region(s) in their query, then call getFacebookAdLibraryCountries to get the list of regions supported by Facebook. Pick the region(s) that match users' inquiry the closest.",
            "items": {
              "type": "string"
            }
          },
          "google_regions": {
            "type": "array",
            "description": "If the user specifies region(s) in their query, then call getGoogleAdsTransparencyCountries to get the list of regions supported by Google. Pick the region(s) that match users' inquiry the closest.",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}