POST v1/GoogleShoppingCampaigns
Request Information
URI Parameters
None.
Body Parameters
ShoppingCampaignName | Type | Description | Comments |
---|---|---|---|
Guid | globally unique identifier | ||
SubscriberGuid | globally unique identifier | ||
GoogleCampaignIdentifier | string | ||
Type | ShoppingCampaignType | ||
CampaignTemplateGuid | globally unique identifier | ||
Title | string | ||
ProductCombinationOperator | LogicalOperator | ||
RecommendationTypes | Collection of BoxType | ||
CollectionIDs | Collection of integer | ||
ProductIDs | Collection of integer | ||
AudienceMode | CampaignAudienceMode | ||
RetargetUserSegmentGuids | Collection of globally unique identifier | ||
BudgetType | CampaignBudgetType | ||
BudgetAmount | decimal number | ||
TargetRoasPercentage | integer | ||
StartDate | date | ||
EndDate | date | ||
UtmSource | string | ||
UtmMedium | string | ||
UtmCampaign | string | ||
UtmContent | string | ||
UtmTrackerIdentifier | string | ||
Status | CampaignStatus | ||
StatusDetails | CampaignStatusDetails | ||
Deleted | boolean | ||
CreateDate | date | ||
VersionDate | date |
Request Formats
application/json, text/json
Sample:
{ "Guid": "41955143-bd3c-4bc5-94c5-f1dc3f31823e", "SubscriberGuid": "9435e890-34a6-4bf4-821f-3ec0ef6de3fc", "GoogleCampaignIdentifier": "sample string 3", "Type": "Smart", "CampaignTemplateGuid": "f48832a1-a5c9-4871-92b2-b3f0b59a6e56", "Title": "sample string 4", "ProductCombinationOperator": "And", "RecommendationTypes": [ "Unknown", "Unknown" ], "CollectionIDs": [ 1, 2 ], "ProductIDs": [ 1, 2 ], "AudienceMode": "Prospect", "RetargetUserSegmentGuids": [ "dd645933-77ff-451a-a747-65036eff515c", "c91c57ea-8311-4c7a-b97c-fcd379c5c7fe" ], "BudgetType": "Daily", "BudgetAmount": 5.0, "TargetRoasPercentage": 1, "StartDate": "2021-01-20T07:39:44.8496876+00:00", "EndDate": "2021-01-20T07:39:44.8496876+00:00", "UtmSource": "sample string 7", "UtmMedium": "sample string 8", "UtmCampaign": "sample string 9", "UtmContent": "sample string 10", "UtmTrackerIdentifier": "sample string 11", "Status": "Draft", "StatusDetails": { "Issues": [ { "Message": "sample string 1", "HelpLink": "sample string 2", "FixLink": "sample string 3", "Level": "Info", "Details": "sample string 4" }, { "Message": "sample string 1", "HelpLink": "sample string 2", "FixLink": "sample string 3", "Level": "Info", "Details": "sample string 4" } ] }, "Deleted": true, "CreateDate": "2021-01-20T07:39:44.8496876+00:00", "VersionDate": "2021-01-20T07:39:44.8496876+00:00" }
Response Information
Resource Description
globally unique identifierResponse Formats
application/json, text/json
Sample:
"8127c522-597e-4741-a9ae-5e44b00d218e"