POST marketing/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": "ca68568a-a474-4ff6-b32d-d0e1d834f7c5", "SubscriberGuid": "b0628bd5-38da-4443-965c-ba228d116d09", "GoogleCampaignIdentifier": "sample string 3", "Type": "Smart", "CampaignTemplateGuid": "55ec0581-6487-422f-8bf8-256c6d11e9fa", "Title": "sample string 4", "ProductCombinationOperator": "And", "RecommendationTypes": [ "Unknown", "Unknown" ], "CollectionIDs": [ 1, 2 ], "ProductIDs": [ 1, 2 ], "AudienceMode": "Prospect", "RetargetUserSegmentGuids": [ "12742aed-7a1b-4e71-b1ec-31f9a486a973", "3d467ab2-7705-46b6-8597-277a8837c941" ], "BudgetType": "Daily", "BudgetAmount": 5.0, "TargetRoasPercentage": 1, "StartDate": "2021-01-20T06:12:04.9931308+00:00", "EndDate": "2021-01-20T06:12:04.9931308+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-20T06:12:04.9931308+00:00", "VersionDate": "2021-01-20T06:12:04.9931308+00:00" }
Response Information
Resource Description
globally unique identifierResponse Formats
application/json, text/json
Sample:
"c0bf3530-6c18-40ae-abe6-c2de0ee9f7c3"