account | GadsAccountItem or object or array of object or string or integer | Yes | - | Select the Google Ads account, ask the user for it if not provided |
action | string or SelectableOption | Yes | - | What to do with the custom audience. Options: ‘CREATE’, ‘UPDATE’, ‘REMOVE’ |
validate_only | boolean | No | False | When true, Google Ads validates the CREATE, UPDATE, or REMOVE request without applying any changes. Returns validation confirmation instead of audience details. A CREATE dry run does not produce an audience ID for subsequent operations. Default: false. |
custom_audience_id | string | No | - | The custom audience ID to update or remove. Required for UPDATE and REMOVE |
name | string | No | - | Name of the custom audience, unique per account. Required for CREATE |
audience_type | string or SelectableOption | No | - | Type of the custom audience. New audiences can only be ‘SEARCH’ (people who searched these terms on Google) or ‘AUTO’ (Google picks interpretation per campaign goal). ‘INTEREST’ and ‘PURCHASE_INTENT’ are legacy types kept only for existing audiences |
description | string | No | - | Description of the custom audience |
members | array of object or object or string | No | - | Members defining the audience, as a list of objects with ‘member_type’ and ‘value’. member_type options: ‘KEYWORD’ (search term or interest keyword), ‘URL’ (a website URL people browse), ‘PLACE_CATEGORY’ (numeric place category ID), ‘APP’ (app package id like ‘com.example.app’). Example: [{“member_type”: “KEYWORD”, “value”: “running shoes”}, {“member_type”: “URL”, “value”: “https://example.com/running”}]. On UPDATE, the provided list fully replaces the audience’s existing members |
