Skip to content

Commit

Permalink
Add title-word-order-optimizer description and config documentation t…
Browse files Browse the repository at this point in the history
…o the READMEs.

PiperOrigin-RevId: 353151960
  • Loading branch information
starmandeluxe committed Jan 28, 2021
1 parent 9411380 commit 6b2e183
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 1 deletion.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,3 +69,4 @@ shopping-exclusion-optimizer | _Sanitization_ | Detects products t
size-length-optimizer | _Optimization_ | The sizes attribute consists of a list containing a single string. This optimizer will trim the sizes attribute to 100 characters and ensure the sizes attribute only contains one value. This will prevent the sizes attribute from being rejected.
title-length-optimizer | _Sanitization/Optimization_ | Truncates title to the max title length if its length exceeds the max value. This will lead to the product avoiding disapproval. Also, if the title is a truncated version of the description, and there is space to expand the title, the title will be expanded. This is expected to improve product performance.
title-optimizer | _Sanitization/Optimization_ | Optimizes title. It will create the title from the description if the title does not exist, truncate the title if it overflows, or complement the title with the description if the title is truncated from the description. It will also remove promotional text from the title. It also appends product attributes to the title after mining them. This is expected to improve product performance. Supported attributes: gender, color, sizes, brand. (This optimizer will also perform attribute mining: brand, color, sizes, and gender attributes will be added to the product fields if they do not exist and could be mined.)
title-word-order-optimizer | _Optimization_ | Optimizes titles using the associated config that specifies title keywords that have high-performing weights for specific product categories. A product in that category whose title contains the high-performing keywords will have its title rearranged to put the matching keywords to the front of the title so they are more prominently displayed in the ad.
2 changes: 2 additions & 0 deletions docs/developer-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ _**Optional:**_
* `size-length-optimizer=(true/false)`
* `title-length-optimizer=(true/false)`
* `title-optimizer=(true/false)`
* `title-word-order-optimizer=(true/false)`

"lang" will control which language is used for certain optimizers that require
language-specific token parsing. The supported language values are: "en"
Expand Down Expand Up @@ -188,6 +189,7 @@ free_shipping_optimizer_config_{lang}.json | free-shipping-optimizer | Set th
gender_optimizer_config_{lang}.json | title-optimizer, description-optimizer | Set the \"**adult_product_categories**\" section to a list of strings representing partial [Google Product Categories](https://support.google.com/merchants/answer/6324436?hl=en) (any part of a tier can match a product's category) that indicate products in those categories should be mined for adult genders. Similarly, set the \"**baby_product_categories**\" to a list of partial GPCs that indicate products in those categories should be mined for baby genders. The next three sections, "female", "male", and "unisex" specify the terms to search the [Product Type](https://support.google.com/merchants/answer/6324406?hl=en) field and description for, and the \"**\*__replacement**\" fields specify the desired terms to set as the gender in the title (for either "baby" or "adult" types of products). See the default configs for examples.
promo_text_removal_optimizer_config_{lang}.json | promo-text-removal-optimizer | Set \"**promotional_text_patterns_regex**\" to a list of strings representing regex patterns that will be matched against the product's title. Set \"**promotional_text_patterns_exact_match**\" to a list of strings representing exact-match patterns that will be matched against the product's title. Matching patterns will be removed from the title.
shopping_exclusion_optimizer_config_{lang}.json | shopping-exclusion-optimizer | Set \"**shopping_exclusion_patterns_exact_match**\" to a list of strings representing text that will be matched against the product's title. If the title contains any of these terms, the optimizer will exclude the product from Shopping ads in the Content API request.
title_word_order_config_{lang}.json | title-word-order-optimizer | _This config is specifically designed to work with a Word-Mix-Model output config file format._ The format is: a dictionary of Google Product Category (GPC) IDs each mapped to a list of dictionaries containing: 1. high-performing title keywords and 2. their associated weight. Thus, only products within the matching GPC will have their titles optimized if possible.

## 4. Integrating Shoptimizer with your Content API Client

Expand Down
2 changes: 1 addition & 1 deletion docs/install-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Run the installation script:

Set the remote destination for your Cloud project's git repo. You can copy the destination URL from the Source Repo page accessed from your GCP project's admin console, or replace the variables in the command shown below:

`git remote add gcp ssh://[YOUR_USERNAME]@google.com@source.developers.google.com:2022/p/[YOUR_GCP_PROJECT_NAME]/r/[NAME_FOR_YOUR_GIT_REPO_IN_GCP]`
`git remote add gcp ssh://[YOUR_USERNAME]@source.developers.google.com:2022/p/[YOUR_GCP_PROJECT_NAME]/r/[NAME_FOR_YOUR_GIT_REPO_IN_GCP]`

Finally, push the code to your GCP project's Cloud Source Repository.

Expand Down

0 comments on commit 6b2e183

Please sign in to comment.