Get Campaign

pinpoint_get_campaign

R Documentation

Retrieves information about the status, configuration, and other settings for a campaign

Description

Retrieves information about the status, configuration, and other settings for a campaign.

Usage

pinpoint_get_campaign(ApplicationId, CampaignId)

Arguments

ApplicationId

[required] The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

CampaignId

[required] The unique identifier for the campaign.

Value

A list with the following syntax:

list(
  CampaignResponse = list(
    AdditionalTreatments = list(
      list(
        CustomDeliveryConfiguration = list(
          DeliveryUri = "string",
          EndpointTypes = list(
            "PUSH"|"GCM"|"APNS"|"APNS_SANDBOX"|"APNS_VOIP"|"APNS_VOIP_SANDBOX"|"ADM"|"SMS"|"VOICE"|"EMAIL"|"BAIDU"|"CUSTOM"|"IN_APP"
          )
        ),
        Id = "string",
        MessageConfiguration = list(
          ADMMessage = list(
            Action = "OPEN_APP"|"DEEP_LINK"|"URL",
            Body = "string",
            ImageIconUrl = "string",
            ImageSmallIconUrl = "string",
            ImageUrl = "string",
            JsonBody = "string",
            MediaUrl = "string",
            RawContent = "string",
            SilentPush = TRUE|FALSE,
            TimeToLive = 123,
            Title = "string",
            Url = "string"
          ),
          APNSMessage = list(
            Action = "OPEN_APP"|"DEEP_LINK"|"URL",
            Body = "string",
            ImageIconUrl = "string",
            ImageSmallIconUrl = "string",
            ImageUrl = "string",
            JsonBody = "string",
            MediaUrl = "string",
            RawContent = "string",
            SilentPush = TRUE|FALSE,
            TimeToLive = 123,
            Title = "string",
            Url = "string"
          ),
          BaiduMessage = list(
            Action = "OPEN_APP"|"DEEP_LINK"|"URL",
            Body = "string",
            ImageIconUrl = "string",
            ImageSmallIconUrl = "string",
            ImageUrl = "string",
            JsonBody = "string",
            MediaUrl = "string",
            RawContent = "string",
            SilentPush = TRUE|FALSE,
            TimeToLive = 123,
            Title = "string",
            Url = "string"
          ),
          CustomMessage = list(
            Data = "string"
          ),
          DefaultMessage = list(
            Action = "OPEN_APP"|"DEEP_LINK"|"URL",
            Body = "string",
            ImageIconUrl = "string",
            ImageSmallIconUrl = "string",
            ImageUrl = "string",
            JsonBody = "string",
            MediaUrl = "string",
            RawContent = "string",
            SilentPush = TRUE|FALSE,
            TimeToLive = 123,
            Title = "string",
            Url = "string"
          ),
          EmailMessage = list(
            Body = "string",
            FromAddress = "string",
            Headers = list(
              list(
                Name = "string",
                Value = "string"
              )
            ),
            HtmlBody = "string",
            Title = "string"
          ),
          GCMMessage = list(
            Action = "OPEN_APP"|"DEEP_LINK"|"URL",
            Body = "string",
            ImageIconUrl = "string",
            ImageSmallIconUrl = "string",
            ImageUrl = "string",
            JsonBody = "string",
            MediaUrl = "string",
            RawContent = "string",
            SilentPush = TRUE|FALSE,
            TimeToLive = 123,
            Title = "string",
            Url = "string"
          ),
          SMSMessage = list(
            Body = "string",
            MessageType = "TRANSACTIONAL"|"PROMOTIONAL",
            OriginationNumber = "string",
            SenderId = "string",
            EntityId = "string",
            TemplateId = "string"
          ),
          InAppMessage = list(
            Body = "string",
            Content = list(
              list(
                BackgroundColor = "string",
                BodyConfig = list(
                  Alignment = "LEFT"|"CENTER"|"RIGHT",
                  Body = "string",
                  TextColor = "string"
                ),
                HeaderConfig = list(
                  Alignment = "LEFT"|"CENTER"|"RIGHT",
                  Header = "string",
                  TextColor = "string"
                ),
                ImageUrl = "string",
                PrimaryBtn = list(
                  Android = list(
                    ButtonAction = "LINK"|"DEEP_LINK"|"CLOSE",
                    Link = "string"
                  ),
                  DefaultConfig = list(
                    BackgroundColor = "string",
                    BorderRadius = 123,
                    ButtonAction = "LINK"|"DEEP_LINK"|"CLOSE",
                    Link = "string",
                    Text = "string",
                    TextColor = "string"
                  ),
                  IOS = list(
                    ButtonAction = "LINK"|"DEEP_LINK"|"CLOSE",
                    Link = "string"
                  ),
                  Web = list(
                    ButtonAction = "LINK"|"DEEP_LINK"|"CLOSE",
                    Link = "string"
                  )
                ),
                SecondaryBtn = list(
                  Android = list(
                    ButtonAction = "LINK"|"DEEP_LINK"|"CLOSE",
                    Link = "string"
                  ),
                  DefaultConfig = list(
                    BackgroundColor = "string",
                    BorderRadius = 123,
                    ButtonAction = "LINK"|"DEEP_LINK"|"CLOSE",
                    Link = "string",
                    Text = "string",
                    TextColor = "string"
                  ),
                  IOS = list(
                    ButtonAction = "LINK"|"DEEP_LINK"|"CLOSE",
                    Link = "string"
                  ),
                  Web = list(
                    ButtonAction = "LINK"|"DEEP_LINK"|"CLOSE",
                    Link = "string"
                  )
                )
              )
            ),
            CustomConfig = list(
              "string"
            ),
            Layout = "BOTTOM_BANNER"|"TOP_BANNER"|"OVERLAYS"|"MOBILE_FEED"|"MIDDLE_BANNER"|"CAROUSEL"
          )
        ),
        Schedule = list(
          EndTime = "string",
          EventFilter = list(
            Dimensions = list(
              Attributes = list(
                list(
                  AttributeType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEFORE"|"AFTER"|"ON"|"BETWEEN",
                  Values = list(
                    "string"
                  )
                )
              ),
              EventType = list(
                DimensionType = "INCLUSIVE"|"EXCLUSIVE",
                Values = list(
                  "string"
                )
              ),
              Metrics = list(
                list(
                  ComparisonOperator = "string",
                  Value = 123.0
                )
              )
            ),
            FilterType = "SYSTEM"|"ENDPOINT"
          ),
          Frequency = "ONCE"|"HOURLY"|"DAILY"|"WEEKLY"|"MONTHLY"|"EVENT"|"IN_APP_EVENT",
          IsLocalTime = TRUE|FALSE,
          QuietTime = list(
            End = "string",
            Start = "string"
          ),
          StartTime = "string",
          Timezone = "string"
        ),
        SizePercent = 123,
        State = list(
          CampaignStatus = "SCHEDULED"|"EXECUTING"|"PENDING_NEXT_RUN"|"COMPLETED"|"PAUSED"|"DELETED"|"INVALID"
        ),
        TemplateConfiguration = list(
          EmailTemplate = list(
            Name = "string",
            Version = "string"
          ),
          PushTemplate = list(
            Name = "string",
            Version = "string"
          ),
          SMSTemplate = list(
            Name = "string",
            Version = "string"
          ),
          VoiceTemplate = list(
            Name = "string",
            Version = "string"
          ),
          InAppTemplate = list(
            Name = "string",
            Version = "string"
          )
        ),
        TreatmentDescription = "string",
        TreatmentName = "string"
      )
    ),
    ApplicationId = "string",
    Arn = "string",
    CreationDate = "string",
    CustomDeliveryConfiguration = list(
      DeliveryUri = "string",
      EndpointTypes = list(
        "PUSH"|"GCM"|"APNS"|"APNS_SANDBOX"|"APNS_VOIP"|"APNS_VOIP_SANDBOX"|"ADM"|"SMS"|"VOICE"|"EMAIL"|"BAIDU"|"CUSTOM"|"IN_APP"
      )
    ),
    DefaultState = list(
      CampaignStatus = "SCHEDULED"|"EXECUTING"|"PENDING_NEXT_RUN"|"COMPLETED"|"PAUSED"|"DELETED"|"INVALID"
    ),
    Description = "string",
    HoldoutPercent = 123,
    Hook = list(
      LambdaFunctionName = "string",
      Mode = "DELIVERY"|"FILTER",
      WebUrl = "string"
    ),
    Id = "string",
    IsPaused = TRUE|FALSE,
    LastModifiedDate = "string",
    Limits = list(
      Daily = 123,
      MaximumDuration = 123,
      MessagesPerSecond = 123,
      Total = 123,
      Session = 123
    ),
    MessageConfiguration = list(
      ADMMessage = list(
        Action = "OPEN_APP"|"DEEP_LINK"|"URL",
        Body = "string",
        ImageIconUrl = "string",
        ImageSmallIconUrl = "string",
        ImageUrl = "string",
        JsonBody = "string",
        MediaUrl = "string",
        RawContent = "string",
        SilentPush = TRUE|FALSE,
        TimeToLive = 123,
        Title = "string",
        Url = "string"
      ),
      APNSMessage = list(
        Action = "OPEN_APP"|"DEEP_LINK"|"URL",
        Body = "string",
        ImageIconUrl = "string",
        ImageSmallIconUrl = "string",
        ImageUrl = "string",
        JsonBody = "string",
        MediaUrl = "string",
        RawContent = "string",
        SilentPush = TRUE|FALSE,
        TimeToLive = 123,
        Title = "string",
        Url = "string"
      ),
      BaiduMessage = list(
        Action = "OPEN_APP"|"DEEP_LINK"|"URL",
        Body = "string",
        ImageIconUrl = "string",
        ImageSmallIconUrl = "string",
        ImageUrl = "string",
        JsonBody = "string",
        MediaUrl = "string",
        RawContent = "string",
        SilentPush = TRUE|FALSE,
        TimeToLive = 123,
        Title = "string",
        Url = "string"
      ),
      CustomMessage = list(
        Data = "string"
      ),
      DefaultMessage = list(
        Action = "OPEN_APP"|"DEEP_LINK"|"URL",
        Body = "string",
        ImageIconUrl = "string",
        ImageSmallIconUrl = "string",
        ImageUrl = "string",
        JsonBody = "string",
        MediaUrl = "string",
        RawContent = "string",
        SilentPush = TRUE|FALSE,
        TimeToLive = 123,
        Title = "string",
        Url = "string"
      ),
      EmailMessage = list(
        Body = "string",
        FromAddress = "string",
        Headers = list(
          list(
            Name = "string",
            Value = "string"
          )
        ),
        HtmlBody = "string",
        Title = "string"
      ),
      GCMMessage = list(
        Action = "OPEN_APP"|"DEEP_LINK"|"URL",
        Body = "string",
        ImageIconUrl = "string",
        ImageSmallIconUrl = "string",
        ImageUrl = "string",
        JsonBody = "string",
        MediaUrl = "string",
        RawContent = "string",
        SilentPush = TRUE|FALSE,
        TimeToLive = 123,
        Title = "string",
        Url = "string"
      ),
      SMSMessage = list(
        Body = "string",
        MessageType = "TRANSACTIONAL"|"PROMOTIONAL",
        OriginationNumber = "string",
        SenderId = "string",
        EntityId = "string",
        TemplateId = "string"
      ),
      InAppMessage = list(
        Body = "string",
        Content = list(
          list(
            BackgroundColor = "string",
            BodyConfig = list(
              Alignment = "LEFT"|"CENTER"|"RIGHT",
              Body = "string",
              TextColor = "string"
            ),
            HeaderConfig = list(
              Alignment = "LEFT"|"CENTER"|"RIGHT",
              Header = "string",
              TextColor = "string"
            ),
            ImageUrl = "string",
            PrimaryBtn = list(
              Android = list(
                ButtonAction = "LINK"|"DEEP_LINK"|"CLOSE",
                Link = "string"
              ),
              DefaultConfig = list(
                BackgroundColor = "string",
                BorderRadius = 123,
                ButtonAction = "LINK"|"DEEP_LINK"|"CLOSE",
                Link = "string",
                Text = "string",
                TextColor = "string"
              ),
              IOS = list(
                ButtonAction = "LINK"|"DEEP_LINK"|"CLOSE",
                Link = "string"
              ),
              Web = list(
                ButtonAction = "LINK"|"DEEP_LINK"|"CLOSE",
                Link = "string"
              )
            ),
            SecondaryBtn = list(
              Android = list(
                ButtonAction = "LINK"|"DEEP_LINK"|"CLOSE",
                Link = "string"
              ),
              DefaultConfig = list(
                BackgroundColor = "string",
                BorderRadius = 123,
                ButtonAction = "LINK"|"DEEP_LINK"|"CLOSE",
                Link = "string",
                Text = "string",
                TextColor = "string"
              ),
              IOS = list(
                ButtonAction = "LINK"|"DEEP_LINK"|"CLOSE",
                Link = "string"
              ),
              Web = list(
                ButtonAction = "LINK"|"DEEP_LINK"|"CLOSE",
                Link = "string"
              )
            )
          )
        ),
        CustomConfig = list(
          "string"
        ),
        Layout = "BOTTOM_BANNER"|"TOP_BANNER"|"OVERLAYS"|"MOBILE_FEED"|"MIDDLE_BANNER"|"CAROUSEL"
      )
    ),
    Name = "string",
    Schedule = list(
      EndTime = "string",
      EventFilter = list(
        Dimensions = list(
          Attributes = list(
            list(
              AttributeType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEFORE"|"AFTER"|"ON"|"BETWEEN",
              Values = list(
                "string"
              )
            )
          ),
          EventType = list(
            DimensionType = "INCLUSIVE"|"EXCLUSIVE",
            Values = list(
              "string"
            )
          ),
          Metrics = list(
            list(
              ComparisonOperator = "string",
              Value = 123.0
            )
          )
        ),
        FilterType = "SYSTEM"|"ENDPOINT"
      ),
      Frequency = "ONCE"|"HOURLY"|"DAILY"|"WEEKLY"|"MONTHLY"|"EVENT"|"IN_APP_EVENT",
      IsLocalTime = TRUE|FALSE,
      QuietTime = list(
        End = "string",
        Start = "string"
      ),
      StartTime = "string",
      Timezone = "string"
    ),
    SegmentId = "string",
    SegmentVersion = 123,
    State = list(
      CampaignStatus = "SCHEDULED"|"EXECUTING"|"PENDING_NEXT_RUN"|"COMPLETED"|"PAUSED"|"DELETED"|"INVALID"
    ),
    tags = list(
      "string"
    ),
    TemplateConfiguration = list(
      EmailTemplate = list(
        Name = "string",
        Version = "string"
      ),
      PushTemplate = list(
        Name = "string",
        Version = "string"
      ),
      SMSTemplate = list(
        Name = "string",
        Version = "string"
      ),
      VoiceTemplate = list(
        Name = "string",
        Version = "string"
      ),
      InAppTemplate = list(
        Name = "string",
        Version = "string"
      )
    ),
    TreatmentDescription = "string",
    TreatmentName = "string",
    Version = 123,
    Priority = 123
  )
)

Request syntax

svc$get_campaign(
  ApplicationId = "string",
  CampaignId = "string"
)