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 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 | ||
ProductVariantGuids | Collection of globally unique identifier | ||
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 | ||
Imported | boolean | ||
StatusDetails | CampaignStatusDetails | ||
Deleted | boolean | ||
CreateDate | date | ||
VersionDate | date |
Response Formats
application/json, text/json
Sample:
[ { "Guid": "64e14c42-7a88-41f2-9ac3-bfa8acf338fc", "SubscriberGuid": "1734a5ee-c380-464b-8ddd-8427948b0a72", "GoogleCampaignIdentifier": "sample string 3", "Type": "Smart", "CampaignTemplateGuid": "327752ad-30fd-4090-a7bf-b51851cc926a", "Title": "sample string 4", "ProductCombinationOperator": "And", "RecommendationTypes": [ "Unknown", "Unknown" ], "CollectionIDs": [ 1, 2 ], "ProductIDs": [ 1, 2 ], "ProductVariantGuids": [ "ecc877d8-1fa4-4cad-84e8-18f4675f4045", "15a9158b-713b-4c3e-83f3-9c51cf19bebc" ], "AudienceMode": "Prospect", "RetargetUserSegmentGuids": [ "54a44e07-3cb2-4802-8046-1dbcd263eaac", "87724ce5-66e3-4e47-ae5d-933507e3333d" ], "BudgetType": "Daily", "BudgetAmount": 5.0, "TargetRoasPercentage": 1, "StartDate": "2021-04-11T01:11:56.3077136+00:00", "EndDate": "2021-04-11T01:11:56.3077136+00:00", "UtmSource": "sample string 7", "UtmMedium": "sample string 8", "UtmCampaign": "sample string 9", "UtmContent": "sample string 10", "UtmTrackerIdentifier": "sample string 11", "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-04-11T01:11:56.3077136+00:00", "VersionDate": "2021-04-11T01:11:56.3077136+00:00" }, { "Guid": "64e14c42-7a88-41f2-9ac3-bfa8acf338fc", "SubscriberGuid": "1734a5ee-c380-464b-8ddd-8427948b0a72", "GoogleCampaignIdentifier": "sample string 3", "Type": "Smart", "CampaignTemplateGuid": "327752ad-30fd-4090-a7bf-b51851cc926a", "Title": "sample string 4", "ProductCombinationOperator": "And", "RecommendationTypes": [ "Unknown", "Unknown" ], "CollectionIDs": [ 1, 2 ], "ProductIDs": [ 1, 2 ], "ProductVariantGuids": [ "ecc877d8-1fa4-4cad-84e8-18f4675f4045", "15a9158b-713b-4c3e-83f3-9c51cf19bebc" ], "AudienceMode": "Prospect", "RetargetUserSegmentGuids": [ "54a44e07-3cb2-4802-8046-1dbcd263eaac", "87724ce5-66e3-4e47-ae5d-933507e3333d" ], "BudgetType": "Daily", "BudgetAmount": 5.0, "TargetRoasPercentage": 1, "StartDate": "2021-04-11T01:11:56.3077136+00:00", "EndDate": "2021-04-11T01:11:56.3077136+00:00", "UtmSource": "sample string 7", "UtmMedium": "sample string 8", "UtmCampaign": "sample string 9", "UtmContent": "sample string 10", "UtmTrackerIdentifier": "sample string 11", "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-04-11T01:11:56.3077136+00:00", "VersionDate": "2021-04-11T01:11:56.3077136+00:00" } ]