-
Notifications
You must be signed in to change notification settings - Fork 4
Body params
Juan Gabriel Griggio edited this page Feb 7, 2025
·
8 revisions
Parameter | Required | Type | Description |
---|---|---|---|
num_headlines |
Yes | int | Number of headlines to generate |
num_descriptions |
Yes | int | Number of descriptions to generate |
advertiser_name |
Yes | str | Name of the advertiser to give more context to Gemini and to be included in the Ads. |
country |
Yes | str | Country of the advertiser to give more context to Gemini. |
first_term_source_config |
Yes | object | Configuration for the first term source. See details here |
second_term_source_config |
If second-term is present in query params |
object | Configuration for the second term source. See details here |
destination_config |
Yes | object | Configuration for the output destination. See details here |
generate_keywords |
No | bool | If true , keywords will be generated using the Google Ads Keyword Planner (if possible) or with Gemini. Defaults to false . |
generate_paths |
No | bool | If true , Path 1 and Path 2 will be generated using Gemini (useful for Responsive Search Ads or RSA). If false or not present, they will not be generated. |
language |
No | str | Language of the content generated. Accepted values: ES , EN . Defaults to ES . |
gemini_model |
No | str | Gemini model to be used, both officials and fine tuned. Read fine tuning docs section for more info. Defaults to gemini-1.5-flash . |
url_validation |
No | str | If REMOVE_BROKEN_URLS , URLs that don't return a 200 (OK), 301 or 302 (REDIRECT) status code will be removed and left blank. If USE_DEFAULT_URL , URLs that don't return a 200 (OK), 301 or 302 (REDIRECT) status code will be swapped for a default URL specified in the default_url parameter. |
default_url |
If url_validation = USE_DEFAULT_URL
|
str | The default URL to use in case of any of the input URLs is broken |
enable_feature_extraction |
No | bool | If true , Topic Mine will understand the products' descriptions and extract their main features to generate the content. If false or not present, it will use the products' descriptions as they are. Good to try both cases and see what works best for you. |
headlines_blocklist |
No | list(str) | List of case-insensitive words or phrases that are blocklisted. Topic Mine will not generate headlines with these words or phrases. |
headlines_regexp_blocklist |
No | list(str) | List of regular expressions that are blocklisted. Topic Mine will not generate headlines that match with these regular expressions. Example: if descriptions with exclamation signs want to be avoided, use the regex .*! . Regular expression matching can be tested here. |
descriptions_blocklist |
No | list(str) | List of case-insensitive words or phrases that are blocklisted. Topic Mine will not generate headlines with these words or phrases. |
descriptions_regexp_blocklist |
No | list(str) | List of regular expressions that are blocklisted. Topic Mine will not generate descriptions that match with these regular expressions. Example: if descriptions with exclamation signs want to be avoided, use the regex .*! . Regular expression matching can be tested here. |
generic_copies |
No | object | Object with generic copies to be used if Gemini could not generate enough copies. |
generic_copies.headlines |
No | list(str) | List of generic headlines. |
generic_copies.descriptions |
No | list(str) | List of generic descriptions. |
- Home
- Project setup
- API Reference
-
Content endpoint
- Query params
-
Body params
- First term source config
- Second term source config
- Output config
- Request examples
- Response examples
- Tasks endpoint
-
Content endpoint