GET v1/GoogleShoppingCampaigns?keyword={keyword}&status={status}
Request Information
URI Parameters
| Name | Type | Description | Comments |
|---|---|---|---|
| keyword | string | ||
| status | CampaignStatus |
Body Parameters
None.
Response Information
Resource Description
Collection of ShoppingCampaign| Name | Type | Description | Comments |
|---|---|---|---|
| Guid | globally unique identifier | ||
| SubscriberGuid | globally unique identifier | ||
| GoogleCampaignIdentifier | string | ||
| Type | ShoppingCampaignType | ||
| CampaignTemplateGuid | globally unique identifier | ||
| Title | string | ||
| ProductRecommendationTypes | Collection of BoxType | ||
| ProductCollectionIDs | 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 | ||
| Status | CampaignStatus | ||
| StatusDetails | CampaignStatusDetails | ||
| Deleted | boolean | ||
| CreateDate | date | ||
| VersionDate | date |
Response Formats
application/json, text/json
Sample:
[
{
"Guid": "eec0cdf7-35a1-4b75-b871-f81aadf77326",
"SubscriberGuid": "fc4d2c90-9fd0-404b-9fb4-2db47cd74c53",
"GoogleCampaignIdentifier": "sample string 3",
"Type": "Smart",
"CampaignTemplateGuid": "d6109a19-0519-450a-98d5-2f4371581d05",
"Title": "sample string 4",
"ProductRecommendationTypes": [
"Unknown",
"Unknown"
],
"ProductCollectionIDs": [
1,
2
],
"AudienceMode": "Prospect",
"RetargetUserSegmentGuids": [
"ebd05c18-fdb8-4df4-bf7d-7558c2981c7e",
"fb40f912-45df-41b5-a085-95be046ff280"
],
"BudgetType": "Daily",
"BudgetAmount": 5.0,
"TargetRoasPercentage": 1,
"StartDate": "2020-10-26T13:04:30.7931177+00:00",
"EndDate": "2020-10-26T13:04:30.7931177+00:00",
"UtmSource": "sample string 7",
"UtmMedium": "sample string 8",
"UtmCampaign": "sample string 9",
"UtmContent": "sample string 10",
"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": "2020-10-26T13:04:30.7931177+00:00",
"VersionDate": "2020-10-26T13:04:30.7931177+00:00"
},
{
"Guid": "eec0cdf7-35a1-4b75-b871-f81aadf77326",
"SubscriberGuid": "fc4d2c90-9fd0-404b-9fb4-2db47cd74c53",
"GoogleCampaignIdentifier": "sample string 3",
"Type": "Smart",
"CampaignTemplateGuid": "d6109a19-0519-450a-98d5-2f4371581d05",
"Title": "sample string 4",
"ProductRecommendationTypes": [
"Unknown",
"Unknown"
],
"ProductCollectionIDs": [
1,
2
],
"AudienceMode": "Prospect",
"RetargetUserSegmentGuids": [
"ebd05c18-fdb8-4df4-bf7d-7558c2981c7e",
"fb40f912-45df-41b5-a085-95be046ff280"
],
"BudgetType": "Daily",
"BudgetAmount": 5.0,
"TargetRoasPercentage": 1,
"StartDate": "2020-10-26T13:04:30.7931177+00:00",
"EndDate": "2020-10-26T13:04:30.7931177+00:00",
"UtmSource": "sample string 7",
"UtmMedium": "sample string 8",
"UtmCampaign": "sample string 9",
"UtmContent": "sample string 10",
"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": "2020-10-26T13:04:30.7931177+00:00",
"VersionDate": "2020-10-26T13:04:30.7931177+00:00"
}
]