personalizer.io Documentation

Help Page Home

GET marketing/v1/GoogleShoppingCampaigns?keyword={keyword}&status={status}

Request Information

URI Parameters

NameTypeDescriptionComments
keyword string

status CampaignStatus

Body Parameters

None.

Response Information

Resource Description

Collection of ShoppingCampaign
NameTypeDescriptionComments
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": "f00bf3e7-1ad2-4972-a966-6046cc4f791c",
    "SubscriberGuid": "f484a0ab-a272-4b70-8915-70e0e45950c8",
    "GoogleCampaignIdentifier": "sample string 3",
    "Type": "Smart",
    "CampaignTemplateGuid": "d081aa7d-d8e6-43d9-b5e4-08cddbdeaaa3",
    "Title": "sample string 4",
    "ProductCombinationOperator": "And",
    "RecommendationTypes": [
      "Unknown",
      "Unknown"
    ],
    "CollectionIDs": [
      1,
      2
    ],
    "ProductIDs": [
      1,
      2
    ],
    "ProductVariantGuids": [
      "a95654c6-7879-466b-a437-deb8ac66baae",
      "48ac6f97-fab3-4eee-b27e-0f1b1214b723"
    ],
    "AudienceMode": "Prospect",
    "RetargetUserSegmentGuids": [
      "ab8113b7-8a77-480e-8222-339fded33a18",
      "777e28f6-8594-4518-b73e-4e19b7294a72"
    ],
    "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-07-27T20:34:12.6493242+00:00",
    "EndDate": "2021-07-27T20:34:12.6493242+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-07-27T20:34:12.6493242+00:00",
    "VersionDate": "2021-07-27T20:34:12.6493242+00:00",
    "CostPerClickBidLimit": 1.0
  },
  {
    "Guid": "f00bf3e7-1ad2-4972-a966-6046cc4f791c",
    "SubscriberGuid": "f484a0ab-a272-4b70-8915-70e0e45950c8",
    "GoogleCampaignIdentifier": "sample string 3",
    "Type": "Smart",
    "CampaignTemplateGuid": "d081aa7d-d8e6-43d9-b5e4-08cddbdeaaa3",
    "Title": "sample string 4",
    "ProductCombinationOperator": "And",
    "RecommendationTypes": [
      "Unknown",
      "Unknown"
    ],
    "CollectionIDs": [
      1,
      2
    ],
    "ProductIDs": [
      1,
      2
    ],
    "ProductVariantGuids": [
      "a95654c6-7879-466b-a437-deb8ac66baae",
      "48ac6f97-fab3-4eee-b27e-0f1b1214b723"
    ],
    "AudienceMode": "Prospect",
    "RetargetUserSegmentGuids": [
      "ab8113b7-8a77-480e-8222-339fded33a18",
      "777e28f6-8594-4518-b73e-4e19b7294a72"
    ],
    "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-07-27T20:34:12.6493242+00:00",
    "EndDate": "2021-07-27T20:34:12.6493242+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-07-27T20:34:12.6493242+00:00",
    "VersionDate": "2021-07-27T20:34:12.6493242+00:00",
    "CostPerClickBidLimit": 1.0
  }
]