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 | ||
| RecommendationTypes | Collection of BoxType | ||
| CollectionIDs | Collection of integer | ||
| ProductIDs | Collection of integer | ||
| ProductVariantGuids | Collection of globally unique identifier | ||
| AudienceMode | CampaignAudienceMode | ||
| RetargetUserSegmentGuids | Collection of globally unique identifier | ||
| AddSimilarAudiences | boolean | ||
| BudgetType | CampaignBudgetType | ||
| BudgetAmount | decimal number | ||
| TargetRoasPercentage | integer | ||
| Priority | CampaignPriority | ||
| BiddingStrategyType | CampaignBiddingStrategy | ||
| GeoTargetSettings | GeoTargetSettings | ||
| StartDate | date | ||
| EndDate | date | ||
| UtmSource | string | ||
| UtmMedium | string | ||
| UtmCampaign | string | ||
| UtmContent | string | ||
| UtmTrackerIdentifier | string | ||
| Status | CampaignStatus | ||
| Imported | boolean | ||
| StatusDetails | CampaignStatusDetails | ||
| Deleted | boolean | ||
| CreateDate | date | ||
| VersionDate | date | ||
| CostPerClickBidLimit | decimal number |
Response Formats
application/json, text/json
Sample:
[
{
"Guid": "4b0946df-9507-499d-a603-3e1295640d0e",
"SubscriberGuid": "de658be2-b9df-4580-b0d5-3670813263bf",
"GoogleCampaignIdentifier": "sample string 3",
"Type": "Smart",
"CampaignTemplateGuid": "03612619-bb54-4b56-a094-c13ce6aa7bdd",
"Title": "sample string 4",
"ProductCombinationOperator": "And",
"RecommendationTypes": [
"Unknown",
"Unknown"
],
"CollectionIDs": [
1,
2
],
"ProductIDs": [
1,
2
],
"ProductVariantGuids": [
"af52c05e-39e9-4a88-bb3a-53336913df7f",
"7f09b056-0785-4132-aaaa-0130dc23afab"
],
"AudienceMode": "Prospect",
"RetargetUserSegmentGuids": [
"4e05efe9-6cd9-4210-ab05-65a33573fe86",
"a36062bf-83a1-4978-99ee-bfc8be79d1ef"
],
"AddSimilarAudiences": true,
"BudgetType": "Daily",
"BudgetAmount": 6.0,
"TargetRoasPercentage": 1,
"Priority": "Low",
"BiddingStrategyType": "ManualCpc",
"GeoTargetSettings": {
"TargetingLocationsIncludeType": "PeopleInOrRegularlyInLocations",
"TargetingLocationsExcludeType": "PeopleInOrRegularlyInLocations",
"TargetingLocationsInclude": [
"sample string 1",
"sample string 2"
],
"TargetingLocationsExclude": [
"sample string 1",
"sample string 2"
]
},
"StartDate": "2021-09-28T08:48:01.6944299+00:00",
"EndDate": "2021-09-28T08:48:01.6944299+00:00",
"UtmSource": "sample string 8",
"UtmMedium": "sample string 9",
"UtmCampaign": "sample string 10",
"UtmContent": "sample string 11",
"UtmTrackerIdentifier": "sample string 12",
"Status": "Draft",
"Imported": true,
"StatusDetails": {
"Issues": [
{
"Message": "sample string 1",
"HelpLink": "sample string 2",
"FixLink": "sample string 3",
"Level": "Info",
"Details": "sample string 4",
"Code": "sample string 5",
"Field": "sample string 6",
"Action": "sample string 7"
},
{
"Message": "sample string 1",
"HelpLink": "sample string 2",
"FixLink": "sample string 3",
"Level": "Info",
"Details": "sample string 4",
"Code": "sample string 5",
"Field": "sample string 6",
"Action": "sample string 7"
}
]
},
"Deleted": true,
"CreateDate": "2021-09-28T08:48:01.6944299+00:00",
"VersionDate": "2021-09-28T08:48:01.6944299+00:00",
"CostPerClickBidLimit": 1.0
},
{
"Guid": "4b0946df-9507-499d-a603-3e1295640d0e",
"SubscriberGuid": "de658be2-b9df-4580-b0d5-3670813263bf",
"GoogleCampaignIdentifier": "sample string 3",
"Type": "Smart",
"CampaignTemplateGuid": "03612619-bb54-4b56-a094-c13ce6aa7bdd",
"Title": "sample string 4",
"ProductCombinationOperator": "And",
"RecommendationTypes": [
"Unknown",
"Unknown"
],
"CollectionIDs": [
1,
2
],
"ProductIDs": [
1,
2
],
"ProductVariantGuids": [
"af52c05e-39e9-4a88-bb3a-53336913df7f",
"7f09b056-0785-4132-aaaa-0130dc23afab"
],
"AudienceMode": "Prospect",
"RetargetUserSegmentGuids": [
"4e05efe9-6cd9-4210-ab05-65a33573fe86",
"a36062bf-83a1-4978-99ee-bfc8be79d1ef"
],
"AddSimilarAudiences": true,
"BudgetType": "Daily",
"BudgetAmount": 6.0,
"TargetRoasPercentage": 1,
"Priority": "Low",
"BiddingStrategyType": "ManualCpc",
"GeoTargetSettings": {
"TargetingLocationsIncludeType": "PeopleInOrRegularlyInLocations",
"TargetingLocationsExcludeType": "PeopleInOrRegularlyInLocations",
"TargetingLocationsInclude": [
"sample string 1",
"sample string 2"
],
"TargetingLocationsExclude": [
"sample string 1",
"sample string 2"
]
},
"StartDate": "2021-09-28T08:48:01.6944299+00:00",
"EndDate": "2021-09-28T08:48:01.6944299+00:00",
"UtmSource": "sample string 8",
"UtmMedium": "sample string 9",
"UtmCampaign": "sample string 10",
"UtmContent": "sample string 11",
"UtmTrackerIdentifier": "sample string 12",
"Status": "Draft",
"Imported": true,
"StatusDetails": {
"Issues": [
{
"Message": "sample string 1",
"HelpLink": "sample string 2",
"FixLink": "sample string 3",
"Level": "Info",
"Details": "sample string 4",
"Code": "sample string 5",
"Field": "sample string 6",
"Action": "sample string 7"
},
{
"Message": "sample string 1",
"HelpLink": "sample string 2",
"FixLink": "sample string 3",
"Level": "Info",
"Details": "sample string 4",
"Code": "sample string 5",
"Field": "sample string 6",
"Action": "sample string 7"
}
]
},
"Deleted": true,
"CreateDate": "2021-09-28T08:48:01.6944299+00:00",
"VersionDate": "2021-09-28T08:48:01.6944299+00:00",
"CostPerClickBidLimit": 1.0
}
]