HighLevel: Upsert audience

← Ad publishing operations · Get started

Operation gohighlevel.google_upsert_audience

Provider route: PUT /ad-publishing/google/audiences. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["adPublishing"]["googleUpsertAudience"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.adPublishing.googleUpsertAudience(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.ad_publishing.google_upsert_audience(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	Model	Required within parent	Expand Upsert audience — request body — body

Referenced models: Upsert audience — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	JSON	Root

Schemas

Upsert audience — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
dimensions	JSON	Optional	Audience dimensions
dimensions (allOf 1)	Model	All variants apply	Expand Upsert audience — request body — body dimensions age Ranges, audience Segments, genders, is Age Unknown, parental Statuses
exclusionDimension	JSON	Optional	Exclusion dimensions
exclusionDimension (allOf 1)	Model	All variants apply	Expand Upsert audience — request body — body dimensions age Ranges, audience Segments, genders, is Age Unknown, parental Statuses
locationId	string	Required within parent	Location identifier
name	string	Required within parent	Audience name
resourceName	string	Optional	Audience resource name

Referenced models: Upsert audience — request body — body dimensions age Ranges, audience Segments, genders, is Age Unknown, parental Statuses

Upsert audience — request body — body dimensions age Ranges, audience Segments, genders, is Age Unknown, parental Statuses

Field	Type	Presence	Description and constraints
$	object	Root
ageRanges	array	Optional	Age range filters
ageRanges[]	string	Each item
audienceSegments	JSON	Optional	Audience segment references used for targeting
audienceSegments (allOf 1)	Model	All variants apply	Expand Upsert audience — request body — body dimensions age Ranges, audience Segments, genders, is Age Unknown, parental Statuses audience Segments custom Audiences, user Interests, user Lists
genders	array	Optional	Gender targets
genders[]	string	Each item
isAgeUnknown	boolean	Optional	Include unknown age
parentalStatuses	array	Optional	Parental status targets
parentalStatuses[]	string	Each item

Referenced models: Upsert audience — request body — body dimensions age Ranges, audience Segments, genders, is Age Unknown, parental Statuses audience Segments custom Audiences, user Interests, user Lists

Upsert audience — request body — body dimensions age Ranges, audience Segments, genders, is Age Unknown, parental Statuses audience Segments custom Audiences, user Interests, user Lists

Field	Type	Presence	Description and constraints
$	object	Root
customAudiences	array	Optional	Resource names of custom audience segments
customAudiences[]	string	Each item
userInterests	array	Optional	Resource names of user interest segments (in-market or affinity audiences)
userInterests[]	string	Each item
userLists	array	Optional	Resource names of user lists (remarketing lists, customer match lists, etc.)
userLists[]	string	Each item

Policy, approvals and errors

SDK function policy ID: gohighlevel.google_upsert_audience. Catalog operation: google-upsert-audience. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["adPublishing.write"]

Pinned headers: {"Version": "v3"}

Official provider source