Gooogle Ads Virtual Assistant
Gooogle Ads Virtual Assistant · GPT Actions
Adzviser Actions for GPT
Equip GPTs with the ability to retrieve real-time reporting data and account settings from Google Ads
GET /google_ads/get_metrics_listgetGoogleAdsMetricsListGet the list of seletable Google Ads metrics, such as Cost, Roas, Impressions, etc.
GET /google_ads/get_breakdowns_listgetGoogleAdsBreakdownsListGet the list of seletable Google Ads breakdowns such as Device, Keyword Text, Campaign Name etc.
POST /search_barsearchQueryRetrieve real-time reporting data such as impressions, cpc, etc. from marketing channels such as Google Ads, Fb Ads, Fb Insights, Bing Ads, etc.
GET /workspace/getgetWorkspaceRetrieve a list of workspaces that have been created by the user and their data sources, such as Google Ads, Facebook Ads accounts connected with each.
POST /google_ads_audit/check_merchant_center_connectioncheckGoogleAdsMerchantCenterConnectionRetrieve whether the Google Merchant Center is connected to the Google Ads account.
POST /google_ads_audit/check_account_settingscheckGoogleAdsAccountSettingsRetrieve the Google Ads account settings such as whether auto tagging is enabled, inventory type, etc.
POST /google_ads_audit/check_negative_keywords_and_placementscheckGoogleAdsNegativeKeywordsAndPlacementsRetrieve the negative keywords and placements set in the Google Ads account.
POST /google_ads_audit/check_remarketing_listcheckGoogleAdsRemarketingListRetrieve the remarketing list set in the Google Ads account.
POST /google_ads_audit/check_conversion_trackingcheckGoogleAdsConversionTrackingRetrieve the conversion tracking status in the Google Ads account.
POST /google_ads_audit/check_bidding_strategycheckGoogleAdsBiddingStrategyRetrieve the bidding strategy set for each active campaigns in the Google Ads account.
POST /google_ads_audit/check_search_campaign_basiccheckSearchCampaignBasicRetrieve the basic information of the search campaigns such as campaign structure, language targeting, country targeting, etc.
POST /google_ads_audit/check_search_campaign_detailedcheckSearchCampaignDetailedRetrieve the detailed information of the search campaigns such as best performing keywords, ad copies, ad extentions, pinned descriptions/headlines etc.
POST /google_ads_audit/check_dynamic_search_adscheckDynamicSearchAdsRetrieve the dynamic search ads information such as dynamic ad targets, negative ad targets, best performing search terms etc.
POST /google_ads_audit/check_pmax_campaigncheckPmaxCampaignRetrieve the performance of the pmax campaigns such as search themes, country/language targeting, final url expansions, excluded urls.
原始 API 定义
{
"openapi": "3.1.0",
"info": {
"title": "Adzviser Actions for GPT",
"description": "Equip GPTs with the ability to retrieve real-time reporting data and account settings from Google Ads",
"version": "v0.0.1"
},
"servers": [
{
"url": "https://copter.adzviser.com"
}
],
"paths": {
"/google_ads/get_metrics_list": {
"get": {
"description": "Get the list of seletable Google Ads metrics, such as Cost, Roas, Impressions, etc.",
"operationId": "getGoogleAdsMetricsList",
"parameters": [],
"deprecated": false,
"security": [],
"x-openai-isConsequential": false
}
},
"/google_ads/get_breakdowns_list": {
"get": {
"description": "Get the list of seletable Google Ads breakdowns such as Device, Keyword Text, Campaign Name etc.",
"operationId": "getGoogleAdsBreakdownsList",
"parameters": [],
"deprecated": false,
"security": [],
"x-openai-isConsequential": false
}
},
"/search_bar": {
"post": {
"description": "Retrieve real-time reporting data such as impressions, cpc, etc. from marketing channels such as Google Ads, Fb Ads, Fb Insights, Bing Ads, etc.",
"operationId": "searchQuery",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/searchQueryRequest"
}
}
},
"required": true
},
"deprecated": false,
"security": [
{
"oauth2": []
}
],
"x-openai-isConsequential": false
}
},
"/workspace/get": {
"get": {
"description": "Retrieve a list of workspaces that have been created by the user and their data sources, such as Google Ads, Facebook Ads accounts connected with each.",
"operationId": "getWorkspace",
"parameters": [],
"deprecated": false,
"security": [
{
"oauth2": []
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getWorkspaceResponse"
}
}
}
}
},
"x-openai-isConsequential": false
}
},
"/google_ads_audit/check_merchant_center_connection": {
"post": {
"description": "Retrieve whether the Google Merchant Center is connected to the Google Ads account.",
"operationId": "checkGoogleAdsMerchantCenterConnection",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googleAdsAuditRequest"
}
}
},
"required": true
},
"x-openai-isConsequential": false
}
},
"/google_ads_audit/check_account_settings": {
"post": {
"description": "Retrieve the Google Ads account settings such as whether auto tagging is enabled, inventory type, etc.",
"operationId": "checkGoogleAdsAccountSettings",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googleAdsAuditRequest"
}
}
},
"required": true
},
"x-openai-isConsequential": false
}
},
"/google_ads_audit/check_negative_keywords_and_placements": {
"post": {
"description": "Retrieve the negative keywords and placements set in the Google Ads account.",
"operationId": "checkGoogleAdsNegativeKeywordsAndPlacements",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googleAdsAuditRequest"
}
}
},
"required": true
},
"x-openai-isConsequential": false
}
},
"/google_ads_audit/check_remarketing_list": {
"post": {
"description": "Retrieve the remarketing list set in the Google Ads account.",
"operationId": "checkGoogleAdsRemarketingList",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googleAdsAuditRequest"
}
}
},
"required": true
},
"x-openai-isConsequential": false
}
},
"/google_ads_audit/check_conversion_tracking": {
"post": {
"description": "Retrieve the conversion tracking status in the Google Ads account.",
"operationId": "checkGoogleAdsConversionTracking",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googleAdsAuditRequest"
}
}
},
"required": true
},
"x-openai-isConsequential": false
}
},
"/google_ads_audit/check_bidding_strategy": {
"post": {
"description": "Retrieve the bidding strategy set for each active campaigns in the Google Ads account.",
"operationId": "checkGoogleAdsBiddingStrategy",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googleAdsAuditRequest"
}
}
},
"required": true
},
"x-openai-isConsequential": false
}
},
"/google_ads_audit/check_search_campaign_basic": {
"post": {
"description": "Retrieve the basic information of the search campaigns such as campaign structure, language targeting, country targeting, etc.",
"operationId": "checkSearchCampaignBasic",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googleAdsAuditRequest"
}
}
},
"required": true
},
"x-openai-isConsequential": false
}
},
"/google_ads_audit/check_search_campaign_detailed": {
"post": {
"description": "Retrieve the detailed information of the search campaigns such as best performing keywords, ad copies, ad extentions, pinned descriptions/headlines etc.",
"operationId": "checkSearchCampaignDetailed",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googleAdsAuditRequest"
}
}
},
"required": true
},
"x-openai-isConsequential": false
}
},
"/google_ads_audit/check_dynamic_search_ads": {
"post": {
"description": "Retrieve the dynamic search ads information such as dynamic ad targets, negative ad targets, best performing search terms etc.",
"operationId": "checkDynamicSearchAds",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googleAdsAuditRequest"
}
}
},
"required": true
},
"x-openai-isConsequential": false
}
},
"/google_ads_audit/check_pmax_campaign": {
"post": {
"description": "Retrieve the performance of the pmax campaigns such as search themes, country/language targeting, final url expansions, excluded urls.",
"operationId": "checkPmaxCampaign",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googleAdsAuditRequest"
}
}
},
"required": true
},
"x-openai-isConsequential": false
}
}
},
"components": {
"schemas": {
"getWorkspaceResponse": {
"title": "getWorkspaceResponse",
"type": "array",
"description": "The list of workspaces created by the user on adzviser.com/main. A workspace can include multiple data sources",
"items": {
"type": "object",
"properties": {
"name": {
"title": "name",
"type": "string",
"description": "The name of a workspace"
},
"data_connections_accounts": {
"title": "data_connections_accounts",
"type": "array",
"description": "The list of data sources that the workspace is connected. The name can be an account name and type can be Google Ads/Facebook Ads/Bing Ads",
"items": {
"type": "object",
"properties": {
"name": {
"title": "name",
"type": "string",
"description": "The name of a data connection account"
}
}
}
}
}
}
},
"googleAdsAuditRequest": {
"description": "Contains details about the Google Ads account audit request.",
"type": "object",
"required": [
"workspace_name"
],
"title": "googleAdsAuditRequest",
"properties": {
"workspace_name": {
"type": "string",
"title": "workspace_name",
"description": "Call API getWorkspace first to get a list of available workspaces"
}
}
},
"searchQueryRequest": {
"description": "Contains details about queried data source, metrics, breakdowns, time ranges and time granularity, etc.",
"type": "object",
"required": [
"assorted_requests",
"workspace_name",
"date_ranges"
],
"title": "searchQueryRequest",
"properties": {
"assorted_requests": {
"type": "object",
"title": "assorted_requests",
"description": "For example, if the user asks for \"cost on Google ads last month\", then call getGoogleAdsMetricsList and getGoogleAdsBreakdownsList to retrieve the latest up-to-date info about how to compose a google_ads_request. A metric is a quantitative measurement. It represents data that can be measured and expressed in numbers. Metrics are used to track performance or behavior. Examples include clicks, impressions, conversions, revenue, etc. A breakdown is a qualitative attribute or descriptor. It provides context for metrics by categorizing or segmenting them. Breakdowns are text. Examples include country, channel, campaign name, etc. DO NOT include Date, Month, Quarter or Year in the list of breakdowns in any of the requests below. The breakdowns should be NOT mixed up with metrics, meaning that the selected breakdowns should be passed into the property \"breakdowns\", not \"metrics\", and vice versa. Last but not least, please always use Python and Code Interpreter to validate and print the JSON object of the composed searchQueryRequest before sending the request to the server (/search_bar). Such a validation on the searchQueryRequest JSON object is to avoid the painful ApiSyntaxErrors.",
"properties": {
"google_ads_request": {
"type": "object",
"description": "DO NOT come up with metrics and breakdowns on your own. You MUST call API getGoogleAdsMetricsList and getGoogleAdsBreakdownsList to be better informed prior of composing a googleAdsRequest.",
"required": [
"metrics",
"breakdowns"
],
"properties": {
"breakdowns": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getGoogleAdsBreakdownsList to retrieve a list of selectable breakdowns."
},
"metrics": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getGoogleAdsMetricsList to retrieve a list of selectable metrics."
}
}
}
}
},
"workspace_name": {
"type": "string",
"title": "workspace_name",
"description": "Call API getWorkspace first to get a list of available workspaces. Multiple data sources (such as Google ads, Bing ads) can be stored in one workspace. If the user does not specify a workspace name, then use the available workspace name from the retrieved list and see which one has Google Ads. If the user has not yet created one, then ask them to go to adzviser.com/main to create a new workspace."
},
"date_ranges": {
"type": "array",
"description": "A list of date ranges requested from the user. They needs to be calculated seperately with Code Interpreter and Python every single time for accuracy. For example, if the user requests \"Google Ads search impression share in May and August\", then this array should be [[\"2024-05-01\", \"2024-05-31\"], [\"2024-08-01\", \"2024-08-31\"]].",
"items": {
"type": "array",
"items": {
"type": "string"
},
"description": "A 2-element array. The first represents the start date and the second the end date. Both are in YYYY-MM-DD format."
}
},
"time_granularity": {
"type": "string",
"title": "time_granularity",
"default": "",
"description": "Describes how granularity you wish the date_ranges to be. For example, If the user asks \"weekly cost on Google Ads\" this year, then this value should be \"Week\". If the user does not specify, then leave it as empty.",
"enum": [
"Date",
"Week",
"Month",
"Quarter"
]
}
}
}
},
"securitySchemes": {
"oauth2": {
"type": "oauth2"
}
}
}
}