# Get Google campaign by ID GET https://services.leadconnectorhq.com/ad-publishing/google/ads/{adId} Retrieve a specific Google Ads campaign by ID ## Authentication Send `Authorization: Bearer ` using: - **Sub-Account token: OAuth access token or Private Integration Token.** Scopes: `adPublishing.readonly` ## Parameters ### Header Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `Version` | string | Yes | API Version | ### Path Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `adId` | string | Yes | Ad identifier | ### Query Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `locationId` | string | Yes | Location identifier | ## OpenAPI Specification ```json { "openapi": "3.0.0", "info": { "title": "HighLevel API", "version": "v3" }, "servers": [ { "url": "https://services.leadconnectorhq.com" } ], "paths": { "/ad-publishing/google/ads/{adId}": { "get": { "summary": "Get Google campaign by ID", "operationId": "getGoogleCampaignById", "description": "Retrieve a specific Google Ads campaign by ID", "parameters": [ { "name": "Version", "in": "header", "description": "API Version", "required": true, "schema": { "type": "string", "enum": [ "v3" ] } }, { "name": "adId", "required": true, "in": "path", "description": "Ad identifier", "schema": { "example": "507f1f77bcf86cd799439011", "type": "string" } }, { "name": "locationId", "required": true, "in": "query", "description": "Location identifier", "schema": { "example": "HChooFuiyPpVYzeJ4HMe", "type": "string" } } ], "responses": { "200": { "description": "The full campaign document, including its ad groups and their ad content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoogleCampaignResponseDTO" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestDTO" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedDTO" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableDTO" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorDTO" } } } } }, "security": [ { "bearer": [ "adPublishing.readonly" ] } ] } } }, "components": { "securitySchemes": { "bearer": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.", "type": "http" }, "Location-Access": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.", "type": "http" }, "Location-Access-Only": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account.", "type": "http" }, "Agency-Access": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.", "type": "http" }, "Agency-Access-Only": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Agency.", "type": "http" } }, "schemas": { "GoogleCampaignResponseDTO": { "type": "object", "properties": { "id": { "type": "string", "description": "Campaign identifier", "example": "6a846b1eb112242a53b21cb0" }, "name": { "type": "string", "description": "Campaign name", "example": "Spring promotion" }, "locationId": { "type": "string", "description": "Location identifier", "example": "fRMewNQIxSyZ5R4nQyit" }, "googleAdAccountId": { "type": "string", "description": "Google Ads customer id the campaign belongs to", "example": "6776452901" }, "advertisingChannelType": { "type": "string", "description": "Advertising channel", "enum": [ "SEARCH", "DEMAND_GEN" ], "example": "DEMAND_GEN" }, "publishingStatus": { "type": "string", "description": "Publishing status", "enum": [ "DRAFT", "SCHEDULED", "PUBLISHED", "PUBLISHING", "FAILED", "IN_REVIEW", "PAUSED", "ARCHIVED", "WITH_ISSUES", "REJECTED" ], "example": "DRAFT" }, "source": { "type": "string", "description": "Where the campaign was created from", "example": "AD_MANAGER" }, "budget": { "description": "Budget configuration", "example": { "budgetType": "DAILY", "amount": 50, "scheduleStartDate": "2026-08-18T00:00:00.000Z", "scheduleEndDate": "2026-09-18T00:00:00.000Z" }, "allOf": [ { "type": "object", "properties": { "budgetType": { "type": "string", "description": "Budget cadence", "example": "DAILY" }, "amount": { "type": "number", "description": "Budget amount in account currency", "example": 50 }, "scheduleStartDate": { "type": "string", "description": "Schedule start", "example": "2026-08-18T00:00:00.000Z" }, "scheduleEndDate": { "type": "string", "description": "Schedule end", "example": "2026-09-18T00:00:00.000Z" } }, "required": [ "budgetType", "amount" ], "title": "GoogleCampaignBudgetDTO" } ] }, "networkSettings": { "description": "Network placement settings", "example": { "targetSearchNetwork": true, "targetContentNetwork": false }, "allOf": [ { "type": "object", "properties": { "targetSearchNetwork": { "type": "boolean", "description": "Serve on the Search network", "example": true }, "targetContentNetwork": { "type": "boolean", "description": "Serve on the Display/content network", "example": false } }, "required": [ "targetSearchNetwork", "targetContentNetwork" ], "title": "GoogleNetworkSettingsDTO" } ] }, "biddingStrategy": { "description": "Bidding configuration", "example": { "type": "MAXIMIZE_CONVERSIONS", "value": 0 }, "allOf": [ { "type": "object", "properties": { "type": { "type": "string", "description": "Bidding strategy", "example": "MAXIMIZE_CONVERSIONS" }, "value": { "type": "number", "description": "Target value for the strategy, 0 when unset", "example": 0 } }, "required": [ "type", "value" ], "title": "GoogleBiddingStrategyResponseDTO" } ] }, "campaignGoal": { "description": "Campaign goal", "example": { "type": "CONVERSIONS", "value": "ADD_TO_CART", "isCustomConversionGoal": false }, "allOf": [ { "type": "object", "properties": { "type": { "type": "string", "description": "Goal type", "enum": [ "CONVERSIONS", "CLICK", "YOUTUBE_ENGAGEMENT" ], "example": "CONVERSIONS" }, "value": { "type": "string", "description": "Goal value — a conversion category, or a conversion action resource name for custom goals", "example": "ADD_TO_CART" }, "isCustomConversionGoal": { "type": "boolean", "description": "Whether the goal is a custom conversion goal", "example": false } }, "required": [ "type" ], "title": "GoogleCampaignGoalResponseDTO" } ] }, "assets": { "type": "object", "description": "Attached assets by kind", "additionalProperties": true, "example": { "calls": [ "customers/6776452901/assets/112233445" ], "sitelinks": [ "customers/6776452901/assets/112233446" ], "leadForm": "customers/6776452901/assets/112233447", "images": [ "customers/6776452901/assets/112233448" ] } }, "audience": { "description": "Campaign level targeting", "example": { "locales": [ { "name": "English", "key": "1000", "id": "1000", "resourceName": "languageConstants/1000" } ], "geoLocations": [ { "key": "geoTargetConstants/2840", "id": "ChIJOwg_06VPwokRYv534QaPC8g", "name": "New York", "countryName": "United States", "type": "city", "radius": 25, "radiusUnit": "mi", "selectionType": "include", "resourceName": "customers/123/geoTargetConstants/2840", "placeId": "ChIJOwg_06VPwokRYv534QaPC8g", "formattedAddress": "New York, NY, USA", "geometry": { "location": { "lat": 40.7128, "lng": -74.006 }, "locationType": "APPROXIMATE" }, "addressComponents": [ { "longName": "New York", "shortName": "NY", "types": [ "locality", "political" ] } ] } ], "gender": [ { "enum": "MALE", "negative": false } ], "ageRange": [ { "enum": "AGE_RANGE_25_34", "negative": false } ], "segments": [ "customers/6776452901/userLists/9215680180" ], "targetInterests": { "affinity": [ "customers/6776452901/userInterests/80351" ], "inMarket": [ "customers/6776452901/userInterests/80148" ] } }, "allOf": [ { "type": "object", "properties": { "locales": { "description": "Language targeting", "example": [ { "name": "English", "key": "1000", "id": "1000", "resourceName": "languageConstants/1000" } ], "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Language display name", "example": "English" }, "key": { "type": "string", "description": "Language key", "example": "1000" }, "id": { "type": "string", "description": "Language identifier", "example": "1000" }, "resourceName": { "type": "string", "description": "Language resource name", "example": "languageConstants/1000" } }, "title": "GoogleLocaleDTO" } }, "geoLocations": { "description": "Geographic targeting", "example": [ { "key": "geoTargetConstants/2840", "id": "ChIJOwg_06VPwokRYv534QaPC8g", "name": "New York", "countryName": "United States", "type": "city", "radius": 25, "radiusUnit": "mi", "selectionType": "include", "resourceName": "customers/123/geoTargetConstants/2840", "placeId": "ChIJOwg_06VPwokRYv534QaPC8g", "formattedAddress": "New York, NY, USA", "geometry": { "location": { "lat": 40.7128, "lng": -74.006 }, "locationType": "APPROXIMATE" }, "addressComponents": [ { "longName": "New York", "shortName": "NY", "types": [ "locality", "political" ] } ] } ], "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Geo target constant resource name", "example": "geoTargetConstants/2840" }, "id": { "type": "string", "description": "Location identifier (place_id)", "example": "ChIJOwg_06VPwokRYv534QaPC8g" }, "name": { "type": "string", "description": "Location display name", "example": "New York" }, "countryName": { "type": "string", "description": "Country name", "example": "United States" }, "type": { "type": "string", "description": "Location type (city, region, country, address, etc.)", "example": "city" }, "radius": { "type": "number", "description": "Radius for proximity targeting", "example": 25 }, "radiusUnit": { "type": "string", "description": "Radius unit", "enum": [ "km", "mi" ], "example": "mi" }, "selectionType": { "type": "string", "description": "Include or exclude this location", "enum": [ "include", "exclude" ], "example": "include" }, "resourceName": { "type": "string", "description": "Google Ads resource name", "example": "customers/123/geoTargetConstants/2840" }, "placeId": { "type": "string", "description": "Google place ID", "example": "ChIJOwg_06VPwokRYv534QaPC8g" }, "formattedAddress": { "type": "string", "description": "Full formatted address string", "example": "New York, NY, USA" }, "geometry": { "description": "Geometry data from Google Geocoding API", "example": { "location": { "lat": 40.7128, "lng": -74.006 }, "locationType": "APPROXIMATE" }, "allOf": [ { "type": "object", "properties": { "location": { "description": "Location coordinates", "example": { "lat": 40.7128, "lng": -74.006 }, "allOf": [ { "type": "object", "properties": { "lat": { "type": "number", "description": "Latitude", "example": 40.7128 }, "lng": { "type": "number", "description": "Longitude", "example": -74.006 } }, "title": "GeoLatLngDTO" } ] }, "locationType": { "type": "string", "description": "Location type (e.g. APPROXIMATE)", "example": "APPROXIMATE" }, "viewport": { "description": "Viewport bounding box", "example": { "northeast": { "lat": 40.8, "lng": -73.9 }, "southwest": { "lat": 40.6, "lng": -74.1 } }, "allOf": [ { "type": "object", "properties": { "northeast": { "description": "Northeast corner of the viewport", "example": { "lat": 40.8, "lng": -73.9 }, "allOf": [ { "type": "object", "properties": { "lat": { "type": "number", "description": "Latitude", "example": 40.7128 }, "lng": { "type": "number", "description": "Longitude", "example": -74.006 } }, "title": "GeoLatLngDTO" } ] }, "southwest": { "description": "Southwest corner of the viewport", "example": { "lat": 40.6, "lng": -74.1 }, "allOf": [ { "type": "object", "properties": { "lat": { "type": "number", "description": "Latitude", "example": 40.7128 }, "lng": { "type": "number", "description": "Longitude", "example": -74.006 } }, "title": "GeoLatLngDTO" } ] } }, "title": "GeoViewportDTO" } ] } }, "title": "GeoGeometryDTO" } ] }, "addressComponents": { "description": "Address components from Google Geocoding API", "example": [ { "longName": "New York", "shortName": "NY", "types": [ "locality", "political" ] } ], "type": "array", "items": { "type": "object", "properties": { "longName": { "type": "string", "description": "Full name of the address component", "example": "New York" }, "shortName": { "type": "string", "description": "Abbreviated name of the address component", "example": "NY" }, "types": { "description": "Address component types", "example": [ "locality", "political" ], "type": "array", "items": { "type": "string" } } }, "title": "GeoAddressComponentDTO" } } }, "title": "GoogleGeoLocationDTO" } }, "gender": { "description": "Gender targeting", "example": [ { "enum": "MALE", "negative": false } ], "type": "array", "items": { "type": "object", "properties": { "enum": { "type": "string", "description": "Gender to target", "example": "MALE", "enum": [ "MALE", "FEMALE", "UNDETERMINED" ] }, "negative": { "type": "boolean", "description": "Whether this is a negative target", "example": false } }, "required": [ "enum", "negative" ], "title": "GoogleGenderTargetDTO" } }, "ageRange": { "description": "Age range targeting", "example": [ { "enum": "AGE_RANGE_25_34", "negative": false } ], "type": "array", "items": { "type": "object", "properties": { "enum": { "type": "string", "description": "Age bucket to target", "example": "AGE_RANGE_25_34", "enum": [ "AGE_RANGE_18_24", "AGE_RANGE_25_34", "AGE_RANGE_35_44", "AGE_RANGE_45_54", "AGE_RANGE_55_64", "AGE_RANGE_65_UP", "AGE_RANGE_UNDETERMINED" ] }, "negative": { "type": "boolean", "description": "Whether this is a negative target", "example": false } }, "required": [ "enum", "negative" ], "title": "GoogleAgeRangeTargetDTO" } }, "segments": { "description": "Audience segment resource names", "example": [ "customers/6776452901/userLists/9215680180" ], "type": "array", "items": { "type": "string" } }, "targetInterests": { "description": "Affinity and in-market interests", "example": { "affinity": [ "customers/6776452901/userInterests/80351" ], "inMarket": [ "customers/6776452901/userInterests/80148" ] }, "allOf": [ { "type": "object", "properties": { "affinity": { "description": "Affinity audience resource names", "example": [ "customers/6776452901/userInterests/80351" ], "type": "array", "items": { "type": "string" } }, "inMarket": { "description": "In-market audience resource names", "example": [ "customers/6776452901/userInterests/80148" ], "type": "array", "items": { "type": "string" } } }, "required": [ "affinity", "inMarket" ], "title": "GoogleTargetInterestsDTO" } ] } }, "required": [ "locales", "geoLocations" ], "title": "GoogleCampaignAudienceDTO" } ] }, "adSchedule": { "description": "Ad scheduling windows, empty when the campaign runs continuously", "example": [ { "dayOfWeek": "ALL_DAYS", "from": "09_00", "to": "17_30", "_id": "6a855ca9867e604d24f4b8fa" } ], "type": "array", "items": { "type": "object", "properties": { "dayOfWeek": { "type": "string", "description": "Day or day-group the window applies to", "enum": [ "FRIDAY", "MONDAY", "SATURDAY", "SUNDAY", "THURSDAY", "TUESDAY", "UNKNOWN", "UNSPECIFIED", "WEDNESDAY", "ALL_DAYS", "MONDAY_TO_FRIDAY", "SATURDAY_AND_SUNDAY" ], "example": "ALL_DAYS" }, "from": { "type": "string", "description": "Window start as `HH_MM` with an underscore separator, not a colon", "example": "09_00" }, "to": { "type": "string", "description": "Window end as `HH_MM` with an underscore separator", "example": "17_30" }, "_id": { "type": "string", "description": "Mongo subdocument id. Note this is `_id`, not `id` — the id transform applies to the top-level document only.", "example": "6a855ca9867e604d24f4b8fa" } }, "required": [ "dayOfWeek", "from", "to" ], "title": "GoogleAdScheduleEntryDTO" } }, "adGroups": { "description": "Ad groups with their ads", "example": [ { "id": "6a846b2db112242a53b21d01", "name": "Ad Group 1", "adCampaignId": "6a846b1eb112242a53b21cb0", "googleAdGroupId": "", "publishingStatus": "DRAFT", "adGroupError": "", "keywords": { "positives": [ "running shoes" ], "negatives": [ "free running shoes" ] }, "customChannels": false, "selectedChannels": [ "GMAIL", "YOUTUBE_IN_STREAM" ], "audience": { "locales": [ { "name": "English", "key": "1000", "id": "1000", "resourceName": "languageConstants/1000" } ], "geoLocations": [ { "key": "geoTargetConstants/2840", "id": "ChIJOwg_06VPwokRYv534QaPC8g", "name": "New York", "countryName": "United States", "type": "city", "radius": 25, "radiusUnit": "mi", "selectionType": "include", "resourceName": "customers/123/geoTargetConstants/2840", "placeId": "ChIJOwg_06VPwokRYv534QaPC8g", "formattedAddress": "New York, NY, USA", "geometry": { "location": { "lat": 40.7128, "lng": -74.006 }, "locationType": "APPROXIMATE" }, "addressComponents": [ { "longName": "New York", "shortName": "NY", "types": [ "locality", "political" ] } ] } ], "gender": [ { "enum": "MALE", "negative": false } ], "ageRange": [ { "enum": "AGE_RANGE_25_34", "negative": false } ], "segments": [ "customers/6776452901/userLists/9215680180" ], "targetInterests": { "affinity": [ "customers/6776452901/userInterests/80351" ], "inMarket": [ "customers/6776452901/userInterests/80148" ] } }, "googleAudienceId": "", "adContent": [ { "id": "6a846b2db112242a53b21d03", "name": "Ad 1", "mediaType": "IMAGE", "headlines": [ "Buy Now", "Best Deals" ], "longHeadlines": [ "Discover Great Deals Today" ], "descriptions": [ "Great products" ], "finalUrl": "https://example.com", "path1": "", "path2": "", "isDeleted": false, "adError": "", "publishingStatus": "DRAFT", "adId": "ad_internal_abc", "adCampaignId": "6a846b1eb112242a53b21cb0", "adGroupId": "6a846b2db112242a53b21d01", "googleAdId": "", "media": [ { "type": "IMAGE", "url": "https://storage.googleapis.com/ad-assets/spring-promo.jpg" } ], "callToActionLabel": "LEARN_MORE", "businessName": "", "youtubeVideoLinks": [ "https://www.youtube.com/watch?v=M7lc1UVf-VE" ], "carouselCards": [ { "headline": "Buy Now", "description": "Great products", "imageUrl": "https://storage.googleapis.com/ad-assets/card-1.jpg" } ], "placements": [ "YOUTUBE_IN_STREAM" ], "customChannels": false } ], "createdAt": "2026-08-18T14:24:45.722Z", "updatedAt": "2026-08-18T14:36:29.400Z" } ], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Ad group identifier", "example": "6a846b2db112242a53b21d01" }, "name": { "type": "string", "description": "Ad group name", "example": "Ad Group 1" }, "adCampaignId": { "type": "string", "description": "Parent campaign id", "example": "6a846b1eb112242a53b21cb0" }, "googleAdGroupId": { "type": "string", "description": "Google Ads ad group id, empty until published", "example": "" }, "publishingStatus": { "type": "string", "description": "Publishing status", "enum": [ "DRAFT", "SCHEDULED", "PUBLISHED", "PUBLISHING", "FAILED", "IN_REVIEW", "PAUSED", "ARCHIVED", "WITH_ISSUES", "REJECTED" ], "example": "DRAFT" }, "adGroupError": { "type": "string", "description": "Publish error, empty when none", "example": "" }, "keywords": { "type": "object", "description": "Keyword targeting, as positive and negative match objects", "additionalProperties": true, "example": { "positives": [ "running shoes" ], "negatives": [ "free running shoes" ] } }, "customChannels": { "type": "boolean", "description": "Whether channel placements were chosen manually", "example": false }, "selectedChannels": { "type": "array", "description": "Channel placements, Demand Gen only", "example": [ "GMAIL", "YOUTUBE_IN_STREAM" ], "items": { "type": "string", "enum": [ "GMAIL", "YOUTUBE_IN_STREAM", "YOUTUBE_SHORTS", "YOUTUBE_IN_FEED", "DISCOVER", "DISPLAY" ] } }, "audience": { "description": "Ad group level targeting", "example": { "locales": [ { "name": "English", "key": "1000", "id": "1000", "resourceName": "languageConstants/1000" } ], "geoLocations": [ { "key": "geoTargetConstants/2840", "id": "ChIJOwg_06VPwokRYv534QaPC8g", "name": "New York", "countryName": "United States", "type": "city", "radius": 25, "radiusUnit": "mi", "selectionType": "include", "resourceName": "customers/123/geoTargetConstants/2840", "placeId": "ChIJOwg_06VPwokRYv534QaPC8g", "formattedAddress": "New York, NY, USA", "geometry": { "location": { "lat": 40.7128, "lng": -74.006 }, "locationType": "APPROXIMATE" }, "addressComponents": [ { "longName": "New York", "shortName": "NY", "types": [ "locality", "political" ] } ] } ], "gender": [ { "enum": "MALE", "negative": false } ], "ageRange": [ { "enum": "AGE_RANGE_25_34", "negative": false } ], "segments": [ "customers/6776452901/userLists/9215680180" ], "targetInterests": { "affinity": [ "customers/6776452901/userInterests/80351" ], "inMarket": [ "customers/6776452901/userInterests/80148" ] } }, "allOf": [ { "type": "object", "properties": { "locales": { "description": "Language targeting", "example": [ { "name": "English", "key": "1000", "id": "1000", "resourceName": "languageConstants/1000" } ], "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Language display name", "example": "English" }, "key": { "type": "string", "description": "Language key", "example": "1000" }, "id": { "type": "string", "description": "Language identifier", "example": "1000" }, "resourceName": { "type": "string", "description": "Language resource name", "example": "languageConstants/1000" } }, "title": "GoogleLocaleDTO" } }, "geoLocations": { "description": "Geographic targeting", "example": [ { "key": "geoTargetConstants/2840", "id": "ChIJOwg_06VPwokRYv534QaPC8g", "name": "New York", "countryName": "United States", "type": "city", "radius": 25, "radiusUnit": "mi", "selectionType": "include", "resourceName": "customers/123/geoTargetConstants/2840", "placeId": "ChIJOwg_06VPwokRYv534QaPC8g", "formattedAddress": "New York, NY, USA", "geometry": { "location": { "lat": 40.7128, "lng": -74.006 }, "locationType": "APPROXIMATE" }, "addressComponents": [ { "longName": "New York", "shortName": "NY", "types": [ "locality", "political" ] } ] } ], "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Geo target constant resource name", "example": "geoTargetConstants/2840" }, "id": { "type": "string", "description": "Location identifier (place_id)", "example": "ChIJOwg_06VPwokRYv534QaPC8g" }, "name": { "type": "string", "description": "Location display name", "example": "New York" }, "countryName": { "type": "string", "description": "Country name", "example": "United States" }, "type": { "type": "string", "description": "Location type (city, region, country, address, etc.)", "example": "city" }, "radius": { "type": "number", "description": "Radius for proximity targeting", "example": 25 }, "radiusUnit": { "type": "string", "description": "Radius unit", "enum": [ "km", "mi" ], "example": "mi" }, "selectionType": { "type": "string", "description": "Include or exclude this location", "enum": [ "include", "exclude" ], "example": "include" }, "resourceName": { "type": "string", "description": "Google Ads resource name", "example": "customers/123/geoTargetConstants/2840" }, "placeId": { "type": "string", "description": "Google place ID", "example": "ChIJOwg_06VPwokRYv534QaPC8g" }, "formattedAddress": { "type": "string", "description": "Full formatted address string", "example": "New York, NY, USA" }, "geometry": { "description": "Geometry data from Google Geocoding API", "example": { "location": { "lat": 40.7128, "lng": -74.006 }, "locationType": "APPROXIMATE" }, "allOf": [ { "type": "object", "properties": { "location": { "description": "Location coordinates", "example": { "lat": 40.7128, "lng": -74.006 }, "allOf": [ { "type": "object", "properties": { "lat": { "type": "number", "description": "Latitude", "example": 40.7128 }, "lng": { "type": "number", "description": "Longitude", "example": -74.006 } }, "title": "GeoLatLngDTO" } ] }, "locationType": { "type": "string", "description": "Location type (e.g. APPROXIMATE)", "example": "APPROXIMATE" }, "viewport": { "description": "Viewport bounding box", "example": { "northeast": { "lat": 40.8, "lng": -73.9 }, "southwest": { "lat": 40.6, "lng": -74.1 } }, "allOf": [ { "type": "object", "properties": { "northeast": { "description": "Northeast corner of the viewport", "example": { "lat": 40.8, "lng": -73.9 }, "allOf": [ { "type": "object", "properties": { "lat": { "type": "number", "description": "Latitude", "example": 40.7128 }, "lng": { "type": "number", "description": "Longitude", "example": -74.006 } }, "title": "GeoLatLngDTO" } ] }, "southwest": { "description": "Southwest corner of the viewport", "example": { "lat": 40.6, "lng": -74.1 }, "allOf": [ { "type": "object", "properties": { "lat": { "type": "number", "description": "Latitude", "example": 40.7128 }, "lng": { "type": "number", "description": "Longitude", "example": -74.006 } }, "title": "GeoLatLngDTO" } ] } }, "title": "GeoViewportDTO" } ] } }, "title": "GeoGeometryDTO" } ] }, "addressComponents": { "description": "Address components from Google Geocoding API", "example": [ { "longName": "New York", "shortName": "NY", "types": [ "locality", "political" ] } ], "type": "array", "items": { "type": "object", "properties": { "longName": { "type": "string", "description": "Full name of the address component", "example": "New York" }, "shortName": { "type": "string", "description": "Abbreviated name of the address component", "example": "NY" }, "types": { "description": "Address component types", "example": [ "locality", "political" ], "type": "array", "items": { "type": "string" } } }, "title": "GeoAddressComponentDTO" } } }, "title": "GoogleGeoLocationDTO" } }, "gender": { "description": "Gender targeting", "example": [ { "enum": "MALE", "negative": false } ], "type": "array", "items": { "type": "object", "properties": { "enum": { "type": "string", "description": "Gender to target", "example": "MALE", "enum": [ "MALE", "FEMALE", "UNDETERMINED" ] }, "negative": { "type": "boolean", "description": "Whether this is a negative target", "example": false } }, "required": [ "enum", "negative" ], "title": "GoogleGenderTargetDTO" } }, "ageRange": { "description": "Age range targeting", "example": [ { "enum": "AGE_RANGE_25_34", "negative": false } ], "type": "array", "items": { "type": "object", "properties": { "enum": { "type": "string", "description": "Age bucket to target", "example": "AGE_RANGE_25_34", "enum": [ "AGE_RANGE_18_24", "AGE_RANGE_25_34", "AGE_RANGE_35_44", "AGE_RANGE_45_54", "AGE_RANGE_55_64", "AGE_RANGE_65_UP", "AGE_RANGE_UNDETERMINED" ] }, "negative": { "type": "boolean", "description": "Whether this is a negative target", "example": false } }, "required": [ "enum", "negative" ], "title": "GoogleAgeRangeTargetDTO" } }, "segments": { "description": "Audience segment resource names", "example": [ "customers/6776452901/userLists/9215680180" ], "type": "array", "items": { "type": "string" } }, "targetInterests": { "description": "Affinity and in-market interests", "example": { "affinity": [ "customers/6776452901/userInterests/80351" ], "inMarket": [ "customers/6776452901/userInterests/80148" ] }, "allOf": [ { "type": "object", "properties": { "affinity": { "description": "Affinity audience resource names", "example": [ "customers/6776452901/userInterests/80351" ], "type": "array", "items": { "type": "string" } }, "inMarket": { "description": "In-market audience resource names", "example": [ "customers/6776452901/userInterests/80148" ], "type": "array", "items": { "type": "string" } } }, "required": [ "affinity", "inMarket" ], "title": "GoogleTargetInterestsDTO" } ] } }, "required": [ "locales", "geoLocations" ], "title": "GoogleCampaignAudienceDTO" } ] }, "googleAudienceId": { "type": "string", "description": "Linked Google audience id, empty when none", "example": "" }, "adContent": { "description": "Ads in this group", "example": [ { "id": "6a846b2db112242a53b21d03", "name": "Ad 1", "mediaType": "IMAGE", "headlines": [ "Buy Now", "Best Deals" ], "longHeadlines": [ "Discover Great Deals Today" ], "descriptions": [ "Great products" ], "finalUrl": "https://example.com", "path1": "", "path2": "", "isDeleted": false, "adError": "", "publishingStatus": "DRAFT", "adId": "ad_internal_abc", "adCampaignId": "6a846b1eb112242a53b21cb0", "adGroupId": "6a846b2db112242a53b21d01", "googleAdId": "", "media": [ { "type": "IMAGE", "url": "https://storage.googleapis.com/ad-assets/spring-promo.jpg" } ], "callToActionLabel": "LEARN_MORE", "businessName": "", "youtubeVideoLinks": [ "https://www.youtube.com/watch?v=M7lc1UVf-VE" ], "carouselCards": [ { "headline": "Buy Now", "description": "Great products", "imageUrl": "https://storage.googleapis.com/ad-assets/card-1.jpg" } ], "placements": [ "YOUTUBE_IN_STREAM" ], "customChannels": false } ], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Ad identifier", "example": "ad_abc123" }, "name": { "type": "string", "description": "Ad name", "example": "Summer Sale Ad" }, "mediaType": { "type": "string", "description": "Media type", "enum": [ "IMAGE", "VIDEO", "CAROUSEL" ], "example": "IMAGE" }, "headlines": { "description": "Ad headlines", "example": [ "Buy Now", "Best Deals" ], "type": "array", "items": { "type": "string" } }, "longHeadlines": { "description": "Long headlines", "example": [ "Discover Great Deals Today" ], "type": "array", "items": { "type": "string" } }, "descriptions": { "description": "Ad descriptions", "example": [ "Great products" ], "type": "array", "items": { "type": "string" } }, "finalUrl": { "type": "string", "description": "Final URL", "example": "https://example.com" }, "path1": { "type": "string", "description": "Display path 1", "example": "products" }, "path2": { "type": "string", "description": "Display path 2", "example": "deals" }, "isDeleted": { "type": "boolean", "description": "Whether the ad is soft-deleted", "example": false }, "adError": { "type": "string", "description": "Ad-level error message from Google", "example": "Landing page URL is invalid" }, "publishingStatus": { "type": "string", "description": "Ad publishing status", "enum": [ "DRAFT", "SCHEDULED", "PUBLISHED", "PUBLISHING", "FAILED", "IN_REVIEW", "PAUSED", "ARCHIVED", "WITH_ISSUES", "REJECTED" ], "example": "PUBLISHED" }, "adId": { "type": "string", "description": "Internal ad identifier", "example": "ad_internal_abc" }, "adCampaignId": { "type": "string", "description": "Ad campaign identifier", "example": "camp_abc123" }, "adGroupId": { "type": "string", "description": "Ad group identifier", "example": "ag_abc123" }, "googleAdId": { "type": "string", "description": "Google Ads ad resource ID", "example": "customers/123/ads/456" }, "media": { "description": "Ad media items", "example": [ { "type": "IMAGE", "src": "https://example.com/ad.jpg" } ], "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Media type", "enum": [ "IMAGE" ], "example": "IMAGE" }, "src": { "type": "string", "description": "Media source URL", "example": "https://example.com/image.jpg" }, "isLogo": { "type": "boolean", "description": "Is logo flag", "example": false }, "error": { "type": "string", "description": "Error message if media failed", "example": "Invalid format" }, "url": { "type": "string", "description": "Public URL of the media", "example": "https://example.com/image.jpg" }, "imageType": { "type": "string", "description": "Image type classification", "example": "SQUARE" } }, "title": "GoogleMediaDTO" } }, "callToActionLabel": { "type": "string", "description": "Call to action label", "enum": [ "AUTOMATED", "LEARN_MORE", "GET_QUOTE", "APPLY_NOW", "SIGN_UP", "CONTACT_US", "SUBSCRIBE", "DOWNLOAD", "BOOK_NOW", "SHOP_NOW", "BUY_NOW", "DONATE_NOW", "ORDER_NOW", "PLAY_NOW", "SEE_MORE" ], "example": "LEARN_MORE" }, "businessName": { "type": "string", "description": "Business name", "example": "Acme Corp" }, "youtubeVideoLinks": { "description": "YouTube video links", "example": [ { "youtubeVideoId": "dQw4w9WgXcQ" } ], "type": "array", "items": { "type": "object", "properties": { "youtubeVideoId": { "type": "string", "description": "YouTube video ID", "example": "dQw4w9WgXcQ" } }, "required": [ "youtubeVideoId" ], "title": "GoogleYouTubeVideoLinkDTO" } }, "carouselCards": { "description": "Carousel cards", "example": [ { "headline": "Shop Now", "finalUrl": "https://example.com", "callToActionLabel": "LEARN_MORE" } ], "type": "array", "items": { "type": "object", "properties": { "headline": { "type": "string", "description": "Card headline", "example": "Shop Now" }, "finalUrl": { "type": "string", "description": "Card final URL", "example": "https://example.com" }, "callToActionLabel": { "type": "string", "description": "Call to action label", "example": "LEARN_MORE" }, "media": { "description": "Card media items", "example": [ { "type": "IMAGE", "src": "https://example.com/card.jpg" } ], "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Media type", "enum": [ "IMAGE" ], "example": "IMAGE" }, "src": { "type": "string", "description": "Media source URL", "example": "https://example.com/image.jpg" }, "isLogo": { "type": "boolean", "description": "Is logo flag", "example": false }, "error": { "type": "string", "description": "Error message if media failed", "example": "Invalid format" }, "url": { "type": "string", "description": "Public URL of the media", "example": "https://example.com/image.jpg" }, "imageType": { "type": "string", "description": "Image type classification", "example": "SQUARE" } }, "title": "GoogleMediaDTO" } } }, "title": "GoogleCarouselCardDTO" } }, "placements": { "type": "array", "description": "Channel placements", "example": [ "YOUTUBE_IN_STREAM" ], "items": { "type": "string", "enum": [ "GMAIL", "YOUTUBE_IN_STREAM", "YOUTUBE_SHORTS", "YOUTUBE_IN_FEED", "DISCOVER", "DISPLAY" ] } }, "customChannels": { "type": "boolean", "description": "Custom channels flag", "example": false } }, "title": "GoogleAdContentDTO" } }, "createdAt": { "type": "string", "description": "Created at", "example": "2026-08-18T14:24:45.722Z" }, "updatedAt": { "type": "string", "description": "Updated at", "example": "2026-08-18T14:36:29.400Z" } }, "required": [ "id", "name", "adCampaignId", "googleAdGroupId", "publishingStatus", "adGroupError", "keywords", "customChannels", "selectedChannels", "audience", "googleAudienceId", "adContent", "createdAt", "updatedAt" ], "title": "GoogleAdGroupResponseDTO" } }, "unpublishedChanges": { "type": "boolean", "description": "Whether the campaign has edits not yet published", "example": false }, "isEuPoliticalAds": { "type": "boolean", "description": "Whether the campaign is declared as EU political advertising", "example": false }, "meta": { "description": "Ancillary campaign metadata", "example": { "evaluate": "{\"opportunityScore\":18,\"confidence\":\"High\",\"band\":\"Low\",\"categories\":[],\"fixItems\":[]}" }, "allOf": [ { "type": "object", "properties": { "evaluate": { "type": "string", "description": "Opportunity-score result, stored as a JSON **string** rather than an object — parse before use. Present only after the campaign has been evaluated.", "example": "{\"opportunityScore\":18,\"confidence\":\"High\",\"band\":\"Low\",\"categories\":[],\"fixItems\":[]}" } }, "title": "GoogleCampaignMetaDTO" } ] }, "createdBy": { "type": "string", "description": "User who created the campaign", "example": "hzN33mfYO5c1LHqsExRC" }, "updatedBy": { "type": "string", "description": "User who last updated the campaign", "example": "hzN33mfYO5c1LHqsExRC" }, "createdAt": { "type": "string", "description": "Created at", "example": "2026-08-18T14:24:30.868Z" }, "updatedAt": { "type": "string", "description": "Updated at", "example": "2026-08-18T14:36:29.195Z" } }, "required": [ "id", "name", "locationId", "googleAdAccountId", "advertisingChannelType", "publishingStatus", "source", "budget", "networkSettings", "biddingStrategy", "campaignGoal", "assets", "audience", "adSchedule", "adGroups", "unpublishedChanges", "isEuPoliticalAds", "createdBy", "updatedBy", "createdAt", "updatedAt" ], "title": "GoogleCampaignResponseDTO" }, "BadRequestDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "message": { "type": "string", "example": "Bad Request" } }, "title": "BadRequestDTO" }, "UnauthorizedDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "message": { "type": "string", "example": "Invalid token: access token is invalid" }, "error": { "type": "string", "example": "Unauthorized" } }, "title": "UnauthorizedDTO" }, "UnprocessableDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 422 }, "message": { "example": [ "Unprocessable Entity" ], "type": "array", "items": { "type": "string" } }, "error": { "type": "string", "example": "Unprocessable Entity" } }, "title": "UnprocessableDTO" }, "InternalServerErrorDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "description": "HTTP status code for an unexpected server error", "example": 500 }, "message": { "type": "string", "description": "Error message describing the server failure", "example": "Internal Server Error" } }, "title": "InternalServerErrorDTO" } } } } ``` ## Code Examples **cURL** ```bash curl -L -X GET 'https://services.leadconnectorhq.com/ad-publishing/google/ads/?locationId=' \ -H 'Authorization: Bearer ' \ -H 'Version: v3' ``` **Node.js** ```javascript const options = { method: 'GET', headers: { Authorization: 'Bearer ', Version: 'v3' } }; try { const response = await fetch('https://services.leadconnectorhq.com/ad-publishing/google/ads/?locationId=', options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` **Python** ```python import requests url = "https://services.leadconnectorhq.com/ad-publishing/google/ads/{adId}" headers = { "Authorization": "Bearer ", "Version": "v3" } params = { "locationId": "" } response = requests.get(url, params=params, headers=headers) print(response.json()) ``` **PHP** ```php 'https://services.leadconnectorhq.com/ad-publishing/google/ads/?locationId=', CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_HTTPHEADER => [ 'Authorization: Bearer ', 'Version: v3', ], ]); $response = curl_exec($curl); curl_close($curl); echo $response; ``` **Java** ```java HttpResponse response = Unirest .get("https://services.leadconnectorhq.com/ad-publishing/google/ads/?locationId=") .header("Authorization", "Bearer ") .header("Version", "v3") .asString(); ``` **Go** ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://services.leadconnectorhq.com/ad-publishing/google/ads/?locationId=" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Version", "v3") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(string(body)) } ``` **Ruby** ```ruby require 'uri' require 'net/http' url = URI("https://services.leadconnectorhq.com/ad-publishing/google/ads/?locationId=") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = "Bearer " request["Version"] = "v3" response = http.request(request) puts response.read_body ``` **PowerShell** ```powershell $headers = @{ "Authorization" = "Bearer " "Version" = "v3" } $response = Invoke-RestMethod -Uri 'https://services.leadconnectorhq.com/ad-publishing/google/ads/?locationId=' -Method 'GET' -Headers $headers $response | ConvertTo-Json ```