Data Formats

This page describes special formats used for strings and integers in request and response data.

String Formats 

Date 

A date string in ISO-8601 format. Example: "2018-10-21".

DateTime 

A date time string in ISO-8601 format. Example: "2018-10-21T16:45:23+02:00".

Decimal 

A float in string representation. This is used for floats where floating point precision is crucial.

LargeInteger 

An integer in string representation. This is used for integer fields where the values potentially exceed the safe integer range (±9007199254740991).

ResponseFieldReference 

A dotted path to a field from a response data schema.

Details and examples can be found in the description of field selection query parameters.

SearchableResponseFieldReference 

A dotted path to a searchable field from a response data schema.

Details and examples can be found in the description of field selection query parameters.

UUID 

A UUID. For instance eb334647-b6a4-4e8a-9410-c84021a548f1.

CompositeID 

ID that consists of multiple different IDs, joined together with a colon (“:”).

Details about the IDs that are included in the particular composite ID can be found in the description of the corresponding field.

Example: 1111:22222222

Integer Formats 

Micros 

A monetary value in micros. For instance 1.20 EUR is 1200000 in micros.

SortDirective 

An integer specifying sort direction and priority for a response data field.

Details and examples can be found in the description of sort query parameters.

Enums 

AccountPerformanceGroupBy 

Valid values:

ADGROUP · CAMPAIGN · CRITERION · DATE

AccountTagScope 

Valid values:

ADMIN · SYSTEM · USER

Action 

Valid values:

ARCHIVE · CREATE · ENABLE · PAUSE

AdPlatform 

Ad platform identifier.

Valid values:

AMAZON · EBAY · GOOGLE · MICROSOFT

AdgroupStatus 

Valid values:

ACTIVE · DELETED · PAUSED

AmazonAccountType 

Valid values:

AGENCY · SELLER · VENDOR

AED · ARS · AUD · BDT · BGN · BRL · CAD · CHF · CLP · CNY · COP · CZK · DKK · EGP · EUR · GBP · GHS · HKD · HRK · HUF · IDR · ILS · INR · JPY · KRW · KWD · MAD · MXN · MYR · NGN · NOK · NZD · PHP · PKR · PLN · RON · RSD · RUB · SAR · SEK · SGD · THB · TRY · TWD · UAH · UGX · USD · VND · ZAR · ZMW

ApiEnumBudgetSubmissionState 

Budget Submission State.

SUBMITTED_ACCEPTED: Budget suggestion was successfully submitted without any edits by the user.

SUBMITTED_EDITED: Edited budget suggestion was successfully submitted.

FAILED: Budget submission failed.

REJECTED: Budget suggestion was rejected.

Valid values:

FAILED · REJECTED · SUBMITTED-ACCEPTED · SUBMITTED-EDITED

ApiEnumSyncMode 

Product Ad Sync Modes.

ADD_MISSING: Ensures that whenever a product ad in the source AdGroup that doesn’t exist yet in the target AdGroup is found, the same product ad will be created in the manual AdGroup.

OVERWRITE: Ensures that set of enabled product ads in the target manual AdGroup is the same as in source auto AdGroup.

Valid values:

ADD-MISSING · OVERWRITE

ApiOptSettingScopeEnum 

Valid values:

ACCOUNT · CAMPAIGN

AssignableUserRole 

User roles which can be used for explicit customer access assignments.

This is a subset of UserRole, it excludes implicit roles.

Valid values:

AGENCY-ADMIN · CUSTOMER-ADMIN · USER

BidType 

Valid values:

CPC · CPM

CampaignOptimizationSupport 

Indicates if a campaign can be optimized by Adspert.

The value SUPPORTED indicates that a campaign can be optimized. All other values indicate that optimization is not possible and why.

Valid values:

SUPPORTED · UNSUPPORTED-ADW-BID-STRATEGY · UNSUPPORTED-ADW-PAYMENT-MODE · UNSUPPORTED-AMZ-RULES · UNSUPPORTED-BNG-BID-STRATEGY · UNSUPPORTED-CAMPAIGN-TYPE · UNSUPPORTED-EBY-MARKETPLACE · UNSUPPORTED-VCPM

CampaignStatus 

Valid values:

ACTIVE · DELETED · PAUSED

CampaignType 

Adspert campaign type.

GOOGLE-DISPLAY: Display campaigns in Google Ads accounts.

GOOGLE-SEARCH: Search campaigns in Google Ads accounts.

GOOGLE-SHOPPING: Shopping campaigns in Google Ads accounts.

GOOGLE-VIDEO: Video campaigns in Google Ads accounts.

GOOGLE-UNIVERSAL-APP: Universal App campaigns in Google Ads accounts.

GOOGLE-EXPRESS: Express campaigns in Google Ads accounts.

GOOGLE-SMART: Smart campaigns in Google Ads accounts.

GOOGLE-HOTEL: Hotel campaigns in Google Ads accounts.

GOOGLE-LOCAL: Local campaigns in Google Ads accounts.

GOOGLE-PERFORMANCE-MAX: Performance Max campaigns in Google Ads accounts.

GOOGLE-UNKNOWN: Campaigns in Google Ads accounts with an unknown type.

GOOGLE-DISCOVERY: Discovery campaigns in Google Ads accounts.

AMAZON-SPONSORED-PRODUCTS: Sponsored products campaigns in Amazon Ads accounts.

AMAZON-SPONSORED-BRANDS: Sponsored brands campaigns in Amazon Ads accounts.

AMAZON-SPONSORED-DISPLAY: Sponsored display campaigns in Amazon Ads accounts.

MICROSOFT-SEARCH: Search campaigns in Microsoft Advertising accounts.

MICROSOFT-SHOPPING: Shopping campaigns in Microsoft Advertising accounts.

MICROSOFT-DYNAMIC-SEARCH-ADS: Dynamic search ads campaigns in Microsoft Advertising accounts.

MICROSOFT-AUDIENCE: Audience campaigns in Microsoft Advertising accounts.

EBAY-PROMOTED-LISTINGS-ADVANCED: Promoted Listings Advanced (cost-per-click) campaigns in eBay accounts.

EBAY-PROMOTED-LISTINGS-STANDARD: Promoted Listings (cost-per-sale) campaigns in eBay accounts.

Valid values:

AMAZON-SPONSORED-BRANDS · AMAZON-SPONSORED-DISPLAY · AMAZON-SPONSORED-PRODUCTS · EBAY-PROMOTED-LISTINGS-ADVANCED · EBAY-PROMOTED-LISTINGS-STANDARD · GOOGLE-DISCOVERY · GOOGLE-DISPLAY · GOOGLE-EXPRESS · GOOGLE-HOTEL · GOOGLE-LOCAL · GOOGLE-PERFORMANCE-MAX · GOOGLE-SEARCH · GOOGLE-SHOPPING · GOOGLE-SMART · GOOGLE-UNIVERSAL-APP · GOOGLE-UNKNOWN · GOOGLE-VIDEO · MICROSOFT-AUDIENCE · MICROSOFT-DYNAMIC-SEARCH-ADS · MICROSOFT-SEARCH · MICROSOFT-SHOPPING

ConversionValueSource 

Valid values:

MANUAL · PLATFORM · PRODUCT

ConversionValueType 

Valid values:

PROFIT · REVENUE

CriterionAdditionCriterionSubtype 

Criterion subtype.

ASIN: Available only for criteria with type PAT.

CATEGORY: Available only for criteria with type PAT.

URL: Available only for criteria with type PLACEMENT.

DOMAIN: Available only for criteria with type PLACEMENT.

Valid values:

ASIN · CATEGORY · DOMAIN · URL

CriterionAdditionCriterionType 

Criterion type.

KEYWORD: Supported platforms: Google Ads, Amazon Ads, Microsoft Ads, Ebay Ads

PAT: Supported platforms: Amazon Ads

PLACEMENT: Supported platforms: Google Ads

MOBILE-APPLICATION: Supported platforms: Google Ads

YOUTUBE-CHANNEL: Supported platforms: Google Ads

YOUTUBE-VIDEO: Supported platforms: Google Ads

Valid values:

KEYWORD · MOBILE-APPLICATION · PAT · PLACEMENT · YOUTUBE-CHANNEL · YOUTUBE-VIDEO

CriterionAdditionDestinationLogState 

Criterion Addition proposal destination log state.

REJECTED: Destination rejected by the user

ADDED: Added Destination.

FAILED: Failed Destination.

Valid values:

ADDED · FAILED · REJECTED

CriterionAdditionDestinationState 

Criterion Addition proposal destination state.

REVIEW: Destination waiting to be reviewed by the user.

ACCEPTED: Destination accepted by the user.

REJECTED: Destination rejected by the user

ADDED: Added Destination.

FAILED: Failed Destination.

Valid values:

ACCEPTED · ADDED · FAILED · REJECTED · REVIEW

CriterionAdditionDestinationType 

Proposal / rule destination type

SELECTED_ADGROUP: Use an explicitly selected adgroup.

SOURCE_ADGROUP: Use the source adgroup as the destination adgroup.

AMZ_CREATE_PAT_ADGROUP

Amazon Ads only.

Create a shared Sponsored Product manual campaign and a PAT adgroup.

AMZ_CREATE_KEYWORD_ADGROUP

Amazon Ads only.

Create a shared Sponsored Product manual campaign and a keyword adgroup.

AMZ_CREATE_EXACT_KEYWORD_ADGROUP

Amazon Ads only.

Create a shared Sponsored Product manual campaign and a match type specific adgroup for Exact keywords.

AMZ_CREATE_PHRASE_KEYWORD_ADGROUP

Amazon Ads only.

Create a shared Sponsored Product manual campaign and a match type specific adgroup for Phrase keywords.

AMZ_CREATE_BROAD_KEYWORD_ADGROUP

Amazon Ads only.

Create a shared Sponsored Product manual campaign and a match type specific adgroup for Broad keywords.

AMZ_CREATE_EXACT_KEYWORD_CAMPAIGN_AND_ADGROUP

Amazon Ads only.

Create match type specific campaign and adgroup for Exact keywords.

AMZ_CREATE_PHRASE_KEYWORD_CAMPAIGN_AND_ADGROUP

Amazon Ads only.

Create match type specific campaign and adgroup for Phrase keywords.

AMZ_CREATE_BORAD_KEYWORD_CAMPAIGN_AND_ADGROUP

Amazon Ads only.

Create match type specific campaign and adgroup for Broad keywords.

AMZ_CREATE_BRAND_KEYWORD_ADGROUP

Amazon Ads only.

Create a shared Sponsored Product manual campaign and a brand adgroup for keywords.

AMZ_CREATE_GENERIC_KEYWORD_ADGROUP

Amazon Ads only.

Create a shared Sponsored Product manual campaign and a generic adgroup for keywords.

AMZ_CREATE_COMPETITOR_KEYWORD_ADGROUP

Amazon Ads only.

Create a shared Sponsored Product manual campaign and a competitor adgroup for keywords.

AMZ_CREATE_BRAND_KEYWORD_CAMPAIGN_AND_ADGROUP

Amazon Ads only.

Create brand campaign and adgroup for keywords.

AMZ_CREATE_GENERIC_KEYWORD_CAMPAIGN_AND_ADGROUP

Amazon Ads only.

Create generic campaign and adgroup for keywords.

AMZ_CREATE_COMPETITOR_KEYWORD_CAMPAIGN_AND_ADGROUP

Amazon Ads only.

Create competitor campaign and adgroup for keywords.

Valid values:

AMAZON-CREATE-BRAND-KEYWORD-ADGROUP · AMAZON-CREATE-BRAND-KEYWORD-CAMPAIGN-AND-ADGROUP · AMAZON-CREATE-BROAD-KEYWORD-ADGROUP · AMAZON-CREATE-BROAD-KEYWORD-CAMPAIGN-AND-ADGROUP · AMAZON-CREATE-COMPETITOR-KEYWORD-ADGROUP · AMAZON-CREATE-COMPETITOR-KEYWORD-CAMPAIGN-AND-ADGROUP · AMAZON-CREATE-EXACT-KEYWORD-ADGROUP · AMAZON-CREATE-EXACT-KEYWORD-CAMPAIGN-AND-ADGROUP · AMAZON-CREATE-GENERIC-KEYWORD-ADGROUP · AMAZON-CREATE-GENERIC-KEYWORD-CAMPAIGN-AND-ADGROUP · AMAZON-CREATE-KEYWORD-ADGROUP · AMAZON-CREATE-PAT-ADGROUP · AMAZON-CREATE-PHRASE-KEYWORD-ADGROUP · AMAZON-CREATE-PHRASE-KEYWORD-CAMPAIGN-AND-ADGROUP · SELECTED-ADGROUP · SOURCE-ADGROUP

CriterionAdditionDestinationWarningType 

Proposal / rule destination warning type.

MATCH_TYPE_MISSING

Match type is missing from the destination definition.

Applies only to destinations that belong to keyword rules / proposals.

MATCH_TYPE_NOT_ALLOWED_TOO_MANY_WORDS: Platform does not allow creation of keywords with given match type, if the number of words in the keyword exceed a specified limit.

MATCH_TYPE_NOT_ALLOWED_FOR_CRITERION_TYPE: Destinations for non-keyword proposals / rules cannot specify a match type.

MATCH_TYPE_NOT_ALLOWED_FOR_DESTINATION: Some platforms have limitations on which match types can be created.

DESTINATION_TYPE_NOT_ALLOWED: Destination type is not allowed for a given rule / proposal.

BIDDABLE_CRITERION_NOT_ALLOWED_FOR_CAMPAIGN_TYPE: Some campaigns do not support biddable criteria of specific types (or no biddable criteria at all).

BIDDABLE_CRITERION_NOT_ALLOWED_IN_EXCLUSION: Biddable (non-negative) destinations are not allowed for proposals where the proposal type is EXCLUSION.

CAMPAIGN_TYPE_NOT_ALLOWED: Campaigns of this type cannot be used as destinations.

ADGROUP_TYPE_NOT_ALLOWED: Adgroups of this type cannot be used as destinations.

ADGROUP_TOO_MANY_PRODUCT_ADS

Amazon Ads only.

This means that one of the AMAZON_CREATE_XXX destination types have been selected, the source adgroup belongs to a Sponsored Products auto campaign, and the number of product ads in the source adgroup exceeds the platform limits for product ads in Sponsored Products manual adgroups.

This means that Adspert wouldn’t be able to sync product ads from the source (auto) adgroup to the destination (manual) adgroup, so the destination is not valid.

CAMPAIGN_TOO_MANY_ADGROUPS

Amazon Ads only.

This means that one of the AMAZON_CREATE_XXX destination types have been selected and the destination campaign has already reached the limit of adgroups that can be created.

ACCOUNT_TOO_MANY_ADGROUPS

Amazon Ads only.

This means that one of the AMAZON_CREATE_XXX destination types have been selected and the account has already reached the limit of adgroups that can be created.

CRITERION_EXISTS: A criterion that would be created for this destination already exists.

CRITERION_EXISTS_NEGATIVE: A negative version of the criterion that would be created for this destination already exists.

CRITERION_EXISTS_BIDDABLE: A biddable version of the criterion that would be created for this destination already exists.

CAMPAIGN_NOT_OPTIMIZED: Destination campaign is currently not optimized (does not belong to an active Performance Group).

CAMPAIGN_NOT_SUPPORTED: Destination campaign cannot be optimized by Adspert.

CAMPAIGN_PAUSED: Destination campaign is paused.

CAMPAIGN_DELETED: Destination campaign is deleted.

ADGROUP_PAUSED: Destination adgroup is paused.

ADGROUP_DELETED: Destination adgroup is deleted.

ADGROUP_DOES_NOT_EXIST: Destination adgroup does not exist.

CRITERION_LIMIT_SOFT: Destination adgroup, campaign, or account has reached / exceeded its soft criterion limit.

CRITERION_LIMIT_HARD: Destination adgroup, campaign, or account has reached / exceeded its hard criterion limit.

DESTINATION_CONFLICT_DUPLICATE: Identical destination has been included in the list of destinations more than once.

DESTINATION_CONFLICT_BIDDABLE: Destination is in conflict with another almost identical non-negative destination in the list of destinations.

DESTINATION_CONFLICT_NEGATIVE: Destination is in conflict with another almost identical negative destination in the list of destinations.

EFFECTIVE_DESTINATION_CONFLICT_DUPLICATE: There is another destination in the list of destination, that is effectively identical to this destination.

EFFECTIVE_DESTINATION_CONFLICT_BIDDABLE: There is another destination in the list of destination, that is effectively identical to this destination, but biddable (non-negative).

EFFECTIVE_DESTINATION_CONFLICT_NEGATIVE: There is another destination in the list of destination, that is effectively identical to this destination, but negative.

Valid values:

ACCOUNT-TOO-MANY-ADGROUPS · ADGROUP-DELETED · ADGROUP-DOES-NOT-EXIST · ADGROUP-PAUSED · ADGROUP-TOO-MANY-PRODUCT-ADS · ADGROUP-TYPE-NOT-ALLOWED · BIDDABLE-CRITERION-NOT-ALLOWED-FOR-CAMPAIGN-TYPE · BIDDABLE-CRITERION-NOT-ALLOWED-IN-EXCLUSION · CAMPAIGN-DELETED · CAMPAIGN-NOT-OPTIMIZED · CAMPAIGN-NOT-SUPPORTED · CAMPAIGN-PAUSED · CAMPAIGN-TOO-MANY-ADGROUPS · CAMPAIGN-TYPE-NOT-ALLOWED · CRITERION-EXISTS · CRITERION-EXISTS-BIDDABLE · CRITERION-EXISTS-NEGATIVE · CRITERION-LIMIT-HARD · CRITERION-LIMIT-SOFT · DESTINATION-CONFLICT-BIDDABLE · DESTINATION-CONFLICT-DUPLICATE · DESTINATION-CONFLICT-NEGATIVE · DESTINATION-TYPE-NOT-ALLOWED · EFFECTIVE-DESTINATION-CONFLICT-BIDDABLE · EFFECTIVE-DESTINATION-CONFLICT-DUPLICATE · EFFECTIVE-DESTINATION-CONFLICT-NEGATIVE · MATCH-TYPE-MISSING · MATCH-TYPE-NOT-ALLOWED-FOR-CRITERION-TYPE · MATCH-TYPE-NOT-ALLOWED-FOR-DESTINATION · MATCH-TYPE-NOT-ALLOWED-TOO-MANY-WORDS

CriterionAdditionForcedReviewReason 

Criterion Addition proposal forced review reason.

INVALID_DESTINATIONS: Not all destinations in the proposal are valid.

MULTIPLE_RULES_MATCHED: Criterion name of the proposal matched multiple different rules.

Valid values:

INVALID-DESTINATIONS · MULTIPLE-RULES-MATCHED

CriterionAdditionMatchType 

Keyword match type.

Valid values:

BROAD · EXACT · PHRASE

CriterionAdditionProposalReason 

Criterion Addition proposal reason.

HIGH_CLICK_VALUE: Criterion was proposed to be added due to a high relative click value.

HIGH_CTR: Criterion was proposed to be added due to a high relative clickthrough rate.

LOW_CTR: Criterion was proposed to be excluded due to a low relative clickthrough rate.

CHEAP_CLICK: Criterion was proposed to be added due to a low relative click cost.

HIGH_VOLUME: Criterion was proposed to be added due to a high relative volume.

LOW_CLICK_VALUE: Criterion was proposed to be excluded due to low relative click value.

ONE_CONVERSION: Criterion was proposed to be added due to having at least one conversion.

Valid values:

CHEAP-CLICK · HIGH-CLICK-VALUE · HIGH-CTR · HIGH-VOLUME · LOW-CLICK-VALUE · LOW-CTR · ONE-CONVERSION

CriterionAdditionProposalState 

Criterion Addition proposal state.

REVIEW: Proposal waiting to be reviewed by the user.

ACCEPTED: Proposal accepted by the user.

REJECTED: Proposal rejected by the user

SUBMITTED: Proposal submitted.

Valid values:

ACCEPTED · REJECTED · REVIEW · SUBMITTED

CriterionAdditionProposalType 

Proposal type.

ADDITION: The proposal is for addition of a new biddable criterion.

EXCLUSION: The proposal is for an exclusion of a criterion (creation of a negative criterion).

Valid values:

ADDITION · EXCLUSION

CriterionAdditionRuleAction 

Criterion addition rule action.

ADD: Proposals that matched a rule with action ADD will automatically be submitted to the platform.

REVIEW: Proposals that matched a rule with action REVIEW will be marked as requiring manual review by the customer.

REJECT: Proposals that matched a rule with action REJECT will automatically be rejected.

Valid values:

ADD · REJECT · REVIEW

CriterionAdditionRuleCampaignType 

Valid values:

AMAZON-SPONSORED-BRANDS · AMAZON-SPONSORED-PRODUCTS-AUTO · AMAZON-SPONSORED-PRODUCTS-MANUAL · EBAY-PROMOTED-LISTINGS-ADVANCED · GOOGLE-DISPLAY · GOOGLE-SEARCH · GOOGLE-SHOPPING · MICROSOFT-SEARCH · MICROSOFT-SHOPPING

CriterionAdditionRuleFilterOperand 

Criterion addition rule filter operand.

KEYWORD

Filter keyword text.

Available only for rules that target KEYWORD criteria.

Allowed filter operations:

STARTS-WITH

NOT-STARTS-WITH

ENDS-WITH

NOT-ENDS-WITH

CONTAINS

NOT-CONTAINS

CONTAINS-WORD

NOT-CONTAINS-WORD

EQUALS

NOT-EQUALS

KEYWORD-WORD-COUNT

Filter keyword word count.

Available only for rules that target KEYWORD criteria.

Allowed filter operations:

GREATER-THAN

GREATER-THAN-OR-EQUAL

LESS-THAN

LESS-THAN-OR-EQUAL

EQUALS

NOT-EQUALS

KEYWORD-WORD-LENGTH

Filter keyword word length.

Available only for rules that target KEYWORD criteria.

Allowed filter operations:

GREATER-THAN

GREATER-THAN-OR-EQUAL

LESS-THAN

LESS-THAN-OR-EQUAL

EQUALS

NOT-EQUALS

DOMAIN

Filter domain text.

Available only for rules that target PLACEMENT criteria.

Allowed filter operations:

STARTS-WITH

NOT-STARTS-WITH

ENDS-WITH

NOT-ENDS-WITH

CONTAINS

NOT-CONTAINS

EQUALS

NOT-EQUALS

Valid values:

DOMAIN · KEYWORD · KEYWORD-LENGTH · KEYWORD-WORD-COUNT

CriterionAdditionRuleFilterOperation 

Criterion addition rule filter operation.

STARTS-WITH

Check if operand starts with one of the string values.

Supported value types: string.

NOT-STARTS-WITH

Check if operand doesn’t start with any of the string values.

Supported value types: string.

ENDS-WITH

Check if operand ends with one of the string values.

Supported value types: string.

NOT-ENDS-WITH

Check if operand doesn’t end with any of the string values.

Supported value types: string.

CONTAINS

Check if operand contains one of the string values.

Supported value types: string.

NOT-CONTAINS

Check if operand doesn’t contain any of the string values.

Supported value types: string.

CONTAINS-WORD

Check if operand contains one of the words.

Supported value types: string.

NOT-CONTAINS-WORD

Check if operand doesn’t contain any of the words.

Supported value types: string.

EQUALS

Check if operand is equal to one of the values.

Supported value types: string, int

NOT-EQUALS

Check if operand is not equal to any of the values.

Supported value types: string, int

GREATER-THAN

Check if operand is greater than the value.

Supported value types: int

GREATER-THAN-OR-EQUAL

Check if operand is greater than or equal to the value.

Supported value types: int

LESS-THAN

Check if operand is less than the value.

Supported value types: int

LESS-THAN-OR-EQUAL

Check if operand is less than or equal to the value.

Supported value types: int

Valid values:

CONTAINS · CONTAINS-WORD · ENDS-WITH · EQUALS · GREATER-THAN · GREATER-THAN-OR-EQUAL · LESS-THAN · LESS-THAN-OR-EQUAL · NOT-CONTAINS · NOT-CONTAINS-WORD · NOT-ENDS-WITH · NOT-EQUALS · NOT-STARTS-WITH · STARTS-WITH

CriterionAdditionRuleLevel 

Criterion Addition Rule Type.

DEFAULT: Default, read-only rules created by Adspert.

PLATFORM: Platform-level rules.

ACCOUNT: Account-level rules.

CAMPAIGN: Campaign-level rules.

ADGROUP: Adgroup-level rules.

Valid values:

ACCOUNT · ADGROUP · CAMPAIGN · DEFAULT · PLATFORM

CriterionAdditionRuleLogAction 

Valid values:

CREATE · DELETE · UPDATE

CriterionAdditionRuleLogReason 

Valid values:

ACCOUNT-MOVED · ADVANCED-MODE-ENABLED · DELETED-OBJECT-CLEANUP · EDITED-BY-USER · MIGRATED-FROM-CA2 · SIMPLE-MODE-ENABLED · SIMPLE-MODE-RULE-UPDATE

CriterionAdditionSettingLevel 

Valid values:

ACCOUNT · CUSTOMER

CriterionAdditionSettingType 

Criterion Addition Setting Type.

MODE

Criterion Addition mode.

Available values: simple, advanced.

In simple mode, Criterion Addition behaviour is controlled by simple-mode-action settings.

In advanced mode, Criterion Addition behaviour is controlled by rules.

ENFORCE-ADVANCED-MODE: If set, simple mode is not allowed. This setting can only be changed by sys admins.

SIMPLE-MODE-ACTION

Effective action when Criterion Addition mode is set to simple.

Available values: review, add, reject.

Valid values:

ENFORCE-ADVANCED-MODE · MODE · SIMPLE-MODE-ACTION

CriterionAdditionSettingValueType 

Criterion Addition Setting Value Type.

INTEGER: Setting value should be treated as an integer.

BOOLEAN: Setting value should be treated as a boolean.

ENUM: Setting value should be treated as an enum.

Valid values:

BOOLEAN · ENUM · INTEGER

CriterionMatchType 

Valid values:

BROAD · EXACT · PHRASE

CriterionStatus 

Valid values:

ACTIVE · DELETED · PAUSED

CriterionType 

Criterion type.

KEYWORD: Supported platforms: Google Ads, Amazon Ads, Microsoft Advertising.

PLACEMENT: Supported platforms: Google Ads

WEBPAGE: Supported platforms: Google Ads

PAT: Supported platforms: Amazon Ads

MOBILE-APP: Supported platforms: Google Ads

MOBILE-APP-CATEGORY: Supported platforms: Google Ads

YOUTUBE-CHANNEL: Supported platforms: Google Ads

YOUTUBE-VIDEO: Supported platforms: Google Ads

PRODUCT-PARTITION: Supported platforms: Google Ads, Microsoft Advertising

DSA-AUTO-TARGET: Supported platforms: Microsoft Advertising

PURCHASES-REMARKETING: Supported platforms: Amazon Ads

VIEWS-REMARKETING: Supported platforms: Amazon Ads

AUDIENCE: Supported platforms: Amazon Ads

KEYWORD-THEME: Supported platforms: Amazon Ads

Valid values:

AUDIENCE · DSA-AUTO-TARGET · KEYWORD · KEYWORD-THEME · MOBILE-APP · MOBILE-APP-CATEGORY · PAT · PLACEMENT · PRODUCT-PARTITION · PURCHASES-REMARKETING · VIEWS-REMARKETING · WEBPAGE · YOUTUBE-CHANNEL · YOUTUBE-VIDEO

Currency 

Valid values:

AED · ARS · AUD · BDT · BGN · BRL · CAD · CHF · CLP · CNY · COP · CZK · DKK · EGP · EUR · GBP · GHS · HKD · HRK · HUF · IDR · ILS · INR · JPY · KRW · KWD · MAD · MXN · MYR · NGN · NOK · NZD · PHP · PKR · PLN · RON · RSD · RUB · SAR · SEK · SGD · THB · TRY · TWD · UAH · UGX · USD · VND · ZAR · ZMW

CustomerPerformanceGroupBy 

Valid values:

ACCOUNT · AMZ-PORTFOLIO · CAMPAIGN · DATE · PERFORMANCE-GROUP

CustomerTagScope 

Valid values:

ADMIN · SYSTEM · USER

CustomerType 

Type of an Adspert customer.

MAIN: Standard customer. May have sub customers (agency clients or billing subsidiaries).

AGENCY-CLIENT: Customer for an agency client with ad accounts from that client. No billing happens in that customer. The ad accounts are billed under the main customer.

BILLING-SUBSIDIARY

A customer used only to bill accounts from another customer. This other customer must be the main customer of the customer or share the same main customer.

No ad accounts are connected a customer of this type.

Valid values:

AGENCY-CLIENT · BILLING-SUBSIDIARY · MAIN

DimensionType 

Valid values:

AGE · AUDIENCE · DAY-OF-WEEK · DEMOGRAPHICS · DEVICE · DOWHOD · DOWHOD-CLUSTER · GENDER · HOUR-OF-DAY · INTEREST · LOCATION · PAGE · PARENTAL-STATUS · REMARKETING · SB-PAGE · SP-PAGE · TOPICS

GroupBy 

Valid values:

DATE · ADSPERT-PRODUCT-ID

InvoiceLanguage 

Valid values:

DE · EN

LabelLevel 

Valid values:

ADGROUP · ALL · CAMPAIGN · CRITERION

OptSettingsType 

Valid values:

ACCOUNT-CONVERSION-VALUE-ADDED · ACCOUNT-CONVERSION-VALUE-FACTOR-ADDED · ACCOUNT-CONVERSION-VALUE-FACTOR-REMOVED · ACCOUNT-CONVERSION-VALUE-FACTOR-UPDATED · ACCOUNT-CONVERSION-VALUE-REMOVED · ACCOUNT-CONVERSION-VALUE-SOURCE-ADDED · ACCOUNT-CONVERSION-VALUE-SOURCE-REMOVED · ACCOUNT-CONVERSION-VALUE-SOURCE-UPDATED · ACCOUNT-CONVERSION-VALUE-TYPE-ADDED · ACCOUNT-CONVERSION-VALUE-TYPE-REMOVED · ACCOUNT-CONVERSION-VALUE-TYPE-UPDATED · ACCOUNT-CONVERSION-VALUE-UPDATED · ACCOUNT-INTRADAY-BIDDING-RULES-OPT-IN · ACCOUNT-INTRADAY-BIDDING-RULES-OPT-OUT · ACCOUNT-PRODUCT-VALUE-FEED-ADDED · CAMPAIGN-CONVERSION-VALUE-ADDED · CAMPAIGN-CONVERSION-VALUE-FACTOR-ADDED · CAMPAIGN-CONVERSION-VALUE-FACTOR-REMOVED · CAMPAIGN-CONVERSION-VALUE-FACTOR-UPDATED · CAMPAIGN-CONVERSION-VALUE-REMOVED · CAMPAIGN-CONVERSION-VALUE-SOURCE-ADDED · CAMPAIGN-CONVERSION-VALUE-SOURCE-REMOVED · CAMPAIGN-CONVERSION-VALUE-SOURCE-UPDATED · CAMPAIGN-CONVERSION-VALUE-TYPE-ADDED · CAMPAIGN-CONVERSION-VALUE-TYPE-REMOVED · CAMPAIGN-CONVERSION-VALUE-TYPE-UPDATED · CAMPAIGN-CONVERSION-VALUE-UPDATED · CAMPAIGN-INTRADAY-BIDDING-RULES-OPT-IN · CAMPAIGN-INTRADAY-BIDDING-RULES-OPT-OUT · CAMPAIGN-MAX-BID-ADDED · CAMPAIGN-MAX-BID-REMOVED · CAMPAIGN-MAX-BID-UPDATED

OptimizationType 

Valid values:

CLICK · PROFIT · REVENUE · VCPM

PerformanceGroupGoalType 

Performance group goal type.

PROFIT-MAXIMIZATION: Profit maximization.

COST-PER-DAY

Cost per day.

goal_value must be specified in micros (i.e. $1 = 1000000 micros).

goal_currency must be not null.

COST-PER-CONVERSION

Cost per conversion.

goal_value must be specified in micros (i.e. $1 = 1000000 micros).

goal_currency must be not null.

COST-PER-CLICK

Cost per click.

goal_value must be specified in micros (i.e. $1 = 1000000 micros).

goal_currency must be not null.

CLICKS-PER-DAY: Clicks per day.

ROI: Return on Investment.

CRR

Cost Revenue Ratio.

Also called Advertising Cost of Sales (ACoS) in Amazon.

ROAS: Return on Advertising Spend.

Valid values:

CLICKS-PER-DAY · COST-PER-CLICK · COST-PER-CONVERSION · COST-PER-DAY · CRR · PROFIT-MAXIMIZATION · ROAS · ROI

PerformanceGroupLogEntryType 

Valid values:

ACCOUNT-DEFAULT-ADDED-ACCOUNT-MOVED · ACCOUNT-DEFAULT-ADDED-BY-USER · ACCOUNT-DEFAULT-ADDED-MIGRATION · ACCOUNT-DEFAULT-DELETED · CAMPAIGN-ADDED-ACCOUNT-DEFAULT · CAMPAIGN-ADDED-ACCOUNT-MOVED · CAMPAIGN-ADDED-AMAZON-MANUAL · CAMPAIGN-ADDED-BY-USER · CAMPAIGN-ADDED-MIGRATION · CAMPAIGN-DELETED-ACCOUNT-ARCHIVED · CAMPAIGN-DELETED-ACCOUNT-DISCONNECTED · CAMPAIGN-DELETED-ACCOUNT-MOVED · CAMPAIGN-DELETED-BY-USER · CAMPAIGN-DELETED-CAMPAIGN-DELETED-IN-PLATFORM · CAMPAIGN-DELETED-CAMPAIGN-UNSUPPORTED · PERFORMANCE-GROUP-CREATED-ACCOUNT-MOVED · PERFORMANCE-GROUP-CREATED-BY-USER · PERFORMANCE-GROUP-CREATED-MIGRATION · PERFORMANCE-GROUP-DELETED-ACCOUNT-MOVED · PERFORMANCE-GROUP-DELETED-BY-USER · PERFORMANCE-GROUP-UPDATED-CURRENCY-CHANGED · PERFORMANCE-GROUP-UPDATED-DISABLED · PERFORMANCE-GROUP-UPDATED-ENABLED · PERFORMANCE-GROUP-UPDATED-GOAL-CHANGED · PERFORMANCE-GROUP-UPDATED-NAME-CHANGED · PERFORMANCE-GROUP-UPDATED-USER-MAX-BID-ADDED · PERFORMANCE-GROUP-UPDATED-USER-MAX-BID-CHANGED · WARNING-ACKNOWLEDGED-ACCOUNT-API-ACCESS-NONE · WARNING-ACKNOWLEDGED-ACCOUNT-API-ACCESS-OK · WARNING-ACKNOWLEDGED-ACCOUNT-API-ACCESS-READ-ONLY · WARNING-ACKNOWLEDGED-ACCOUNT-ARCHIVED · WARNING-ACKNOWLEDGED-ACCOUNT-DISCONNECTED · WARNING-ACKNOWLEDGED-ACCOUNT-MOVED · WARNING-ACKNOWLEDGED-CAMPAIGN-ACTIVATED · WARNING-ACKNOWLEDGED-CAMPAIGN-ADDED-ACCOUNT-DEFAULT · WARNING-ACKNOWLEDGED-CAMPAIGN-ADDED-AMAZON-MANUAL · WARNING-ACKNOWLEDGED-CAMPAIGN-DELETED · WARNING-ACKNOWLEDGED-CAMPAIGN-INVALID-OPTIMIZATION-TYPE · WARNING-ACKNOWLEDGED-CAMPAIGN-PAUSED · WARNING-ACKNOWLEDGED-CAMPAIGN-UNSUPPORTED · WARNING-ACKNOWLEDGED-GOAL-UNREACHABLE-FIRST · WARNING-ACKNOWLEDGED-GOAL-UNREACHABLE-SECOND · WARNING-ACKNOWLEDGED-LEGACY-INVALID-CAMPAIGN-OPTIMIZATION-TYPE · WARNING-ACKNOWLEDGED-LEGACY-INVALID-GOAL-TYPE · WARNING-ADDED-ACCOUNT-API-ACCESS-NONE · WARNING-ADDED-ACCOUNT-API-ACCESS-OK · WARNING-ADDED-ACCOUNT-API-ACCESS-READ-ONLY · WARNING-ADDED-ACCOUNT-ARCHIVED · WARNING-ADDED-ACCOUNT-DISCONNECTED · WARNING-ADDED-ACCOUNT-MOVED · WARNING-ADDED-CAMPAIGN-ACTIVATED · WARNING-ADDED-CAMPAIGN-ADDED-ACCOUNT-DEFAULT · WARNING-ADDED-CAMPAIGN-ADDED-AMAZON-MANUAL · WARNING-ADDED-CAMPAIGN-DELETED · WARNING-ADDED-CAMPAIGN-INVALID-OPTIMIZATION-TYPE · WARNING-ADDED-CAMPAIGN-PAUSED · WARNING-ADDED-CAMPAIGN-UNSUPPORTED · WARNING-ADDED-GOAL-UNREACHABLE-FIRST · WARNING-ADDED-GOAL-UNREACHABLE-SECOND · WARNING-ADDED-LEGACY-INVALID-CAMPAIGN-OPTIMIZATION-TYPE · WARNING-ADDED-LEGACY-INVALID-GOAL-TYPE · WARNING-DELETED-ACCOUNT-API-ACCESS-NONE · WARNING-DELETED-ACCOUNT-API-ACCESS-OK · WARNING-DELETED-ACCOUNT-API-ACCESS-READ-ONLY · WARNING-DELETED-ACCOUNT-ARCHIVED · WARNING-DELETED-ACCOUNT-DISCONNECTED · WARNING-DELETED-ACCOUNT-MOVED · WARNING-DELETED-CAMPAIGN-ACTIVATED · WARNING-DELETED-CAMPAIGN-ADDED-ACCOUNT-DEFAULT · WARNING-DELETED-CAMPAIGN-ADDED-AMAZON-MANUAL · WARNING-DELETED-CAMPAIGN-DELETED · WARNING-DELETED-CAMPAIGN-INVALID-OPTIMIZATION-TYPE · WARNING-DELETED-CAMPAIGN-PAUSED · WARNING-DELETED-CAMPAIGN-UNSUPPORTED · WARNING-DELETED-GOAL-UNREACHABLE-FIRST · WARNING-DELETED-GOAL-UNREACHABLE-SECOND · WARNING-DELETED-LEGACY-INVALID-CAMPAIGN-OPTIMIZATION-TYPE · WARNING-DELETED-LEGACY-INVALID-GOAL-TYPE

PerformanceGroupWarningPriority 

Valid values:

HIGH · LOW · MEDIUM

PerformanceGroupWarningStatus 

Performance group warning status.

HIGH-PRIORITY: Performance group has at least one unacknowledged warning of HIGH priority.

MEDIUM-PRIORITY: Performance group has at least one unacknowledged warning of MEDIUM priority and no unacknowledged warnings of HIGH priority.

LOW-PRIORITY: Performance group has at least one unacknowledged warning of LOW priority and no unacknowledged warnings of HIGH or MEDIUM priority.

ACKNOWLEDGED: Performance group has warnings, but all of them are acknowledged.

NO-WARNINGS: Performance group has no warnings.

Valid values:

ACKNOWLEDGED · HIGH-PRIORITY · LOW-PRIORITY · MEDIUM-PRIORITY · NO-WARNINGS