{ "openapi": "3.0.1", "info": { "title": "Google Ads Offline Conversions - GCLID & Enhanced Conversions", "description": "Upload offline conversions to Google Ads using GCLID click tracking, enhanced conversions with hashed PII & store sales data for campaign attribution.\nUpload conversions w/GCLID\nUpload phone calls\nUpload w/hashed PII \nUpload in-store transactions\nAll conversion actions\nConversion action details", "version": "1.0", "x-build-id": "6tsBtzng3rZ1K4kCq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alizarin_refrigerator-owner~google-ads-offline-conversions---gclid-enhanced-conversions/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alizarin_refrigerator-owner-google-ads-offline-conversions---gclid-enhanced-conversions", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/alizarin_refrigerator-owner~google-ads-offline-conversions---gclid-enhanced-conversions/runs": { "post": { "operationId": "runs-sync-alizarin_refrigerator-owner-google-ads-offline-conversions---gclid-enhanced-conversions", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/alizarin_refrigerator-owner~google-ads-offline-conversions---gclid-enhanced-conversions/run-sync": { "post": { "operationId": "run-sync-alizarin_refrigerator-owner-google-ads-offline-conversions---gclid-enhanced-conversions", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "task" ], "properties": { "task": { "title": "Task", "enum": [ "upload_click_conversions", "upload_call_conversions", "upload_enhanced_conversions", "upload_store_sales", "list_conversion_actions", "get_conversion_action", "create_conversion_action", "get_upload_status" ], "type": "string", "description": "The operation to perform", "default": "upload_click_conversions" }, "developerToken": { "title": "Google Ads Developer Token", "type": "string", "description": "Google Ads API developer token" }, "clientId": { "title": "OAuth Client ID", "type": "string", "description": "Google OAuth 2.0 client ID" }, "clientSecret": { "title": "OAuth Client Secret", "type": "string", "description": "Google OAuth 2.0 client secret" }, "refreshToken": { "title": "OAuth Refresh Token", "type": "string", "description": "Google OAuth 2.0 refresh token" }, "customerId": { "title": "Google Ads Customer ID", "type": "string", "description": "Google Ads customer ID (format: 123-456-7890)" }, "loginCustomerId": { "title": "Login Customer ID (MCC)", "type": "string", "description": "Manager account ID if accessing via MCC" }, "conversionActionId": { "title": "Conversion Action ID", "type": "string", "description": "ID of the conversion action to attribute conversions to" }, "conversionActionName": { "title": "Conversion Action Name", "type": "string", "description": "Name for new conversion action" }, "conversions": { "title": "Conversions (JSON Array)", "type": "string", "description": "JSON array of conversion objects" }, "gclid": { "title": "Google Click ID (gclid)", "type": "string", "description": "Google click ID from URL parameter" }, "gbraid": { "title": "Google App Click ID (gbraid)", "type": "string", "description": "Google app click ID for iOS" }, "wbraid": { "title": "Google Web Click ID (wbraid)", "type": "string", "description": "Google web-to-app click ID" }, "conversionDateTime": { "title": "Conversion Date/Time", "type": "string", "description": "When the conversion occurred (format: yyyy-MM-dd HH:mm:ss+|-HH:mm)" }, "conversionValue": { "title": "Conversion Value", "type": "number", "description": "Monetary value of the conversion" }, "currencyCode": { "title": "Currency Code", "type": "string", "description": "ISO 4217 currency code", "default": "USD" }, "orderId": { "title": "Order ID", "type": "string", "description": "Unique order/transaction identifier for deduplication" }, "email": { "title": "Email (Enhanced Conversions)", "type": "string", "description": "Customer email for enhanced conversions (will be hashed)" }, "phone": { "title": "Phone (Enhanced Conversions)", "type": "string", "description": "Customer phone for enhanced conversions (will be hashed)" }, "firstName": { "title": "First Name", "type": "string", "description": "Customer first name (will be hashed)" }, "lastName": { "title": "Last Name", "type": "string", "description": "Customer last name (will be hashed)" }, "streetAddress": { "title": "Street Address", "type": "string", "description": "Customer street address (will be hashed)" }, "city": { "title": "City", "type": "string", "description": "Customer city" }, "state": { "title": "State", "type": "string", "description": "Customer state/region" }, "postalCode": { "title": "Postal Code", "type": "string", "description": "Customer postal/zip code" }, "countryCode": { "title": "Country Code", "type": "string", "description": "Customer country (ISO 3166-1 alpha-2)", "default": "US" }, "callerId": { "title": "Caller ID", "type": "string", "description": "Phone number for call conversions (E.164 format)" }, "callStartDateTime": { "title": "Call Start Date/Time", "type": "string", "description": "When the call started" }, "consent": { "title": "Consent (JSON)", "type": "string", "description": "JSON with ad_user_data and ad_personalization consent (GRANTED/DENIED)" }, "isAlreadyHashed": { "title": "Data Already Hashed", "type": "boolean", "description": "Set to true if PII data is already SHA256 hashed", "default": false }, "webhookUrl": { "title": "Result Webhook URL", "type": "string", "description": "URL to receive results via webhook" }, "demoMode": { "title": "Demo Mode", "type": "boolean", "description": "Run with sample data for testing (no external API calls)", "default": true } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }