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 | ||
| ProductCombinationOperator | LogicalOperator | ||
| 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 | ||
| UtmTrackerIdentifier | string | ||
| Status | CampaignStatus | ||
| StatusDetails | CampaignStatusDetails | ||
| Deleted | boolean | ||
| CreateDate | date | ||
| VersionDate | date |
Response Formats
application/json, text/json
Sample:
[
{
"Guid": "7d724f0c-546e-49c3-bfc3-5e2daee82022",
"SubscriberGuid": "908bede5-4351-4034-8a4a-edc827b491b3",
"GoogleCampaignIdentifier": "sample string 3",
"Type": "Smart",
"CampaignTemplateGuid": "41cf490f-9647-4b63-a6b9-3715c5566b6b",
"Title": "sample string 4",
"ProductCombinationOperator": "And",
"ProductRecommendationTypes": [
"Unknown",
"Unknown"
],
"ProductCollectionIDs": [
1,
2
],
"AudienceMode": "Prospect",
"RetargetUserSegmentGuids": [
"f30548e8-f179-4e59-b273-52b663b2fcda",
"10a2b5e9-423f-4a6e-9e7e-e48f0bf80378"
],
"BudgetType": "Daily",
"BudgetAmount": 5.0,
"TargetRoasPercentage": 1,
"StartDate": "2021-01-18T00:58:27.8046949+00:00",
"EndDate": "2021-01-18T00:58:27.8046949+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-18T00:58:27.8046949+00:00",
"VersionDate": "2021-01-18T00:58:27.8046949+00:00"
},
{
"Guid": "7d724f0c-546e-49c3-bfc3-5e2daee82022",
"SubscriberGuid": "908bede5-4351-4034-8a4a-edc827b491b3",
"GoogleCampaignIdentifier": "sample string 3",
"Type": "Smart",
"CampaignTemplateGuid": "41cf490f-9647-4b63-a6b9-3715c5566b6b",
"Title": "sample string 4",
"ProductCombinationOperator": "And",
"ProductRecommendationTypes": [
"Unknown",
"Unknown"
],
"ProductCollectionIDs": [
1,
2
],
"AudienceMode": "Prospect",
"RetargetUserSegmentGuids": [
"f30548e8-f179-4e59-b273-52b663b2fcda",
"10a2b5e9-423f-4a6e-9e7e-e48f0bf80378"
],
"BudgetType": "Daily",
"BudgetAmount": 5.0,
"TargetRoasPercentage": 1,
"StartDate": "2021-01-18T00:58:27.8046949+00:00",
"EndDate": "2021-01-18T00:58:27.8046949+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-18T00:58:27.8046949+00:00",
"VersionDate": "2021-01-18T00:58:27.8046949+00:00"
}
]