プロアクティブサジェスチョンREST APIリファレンス

{
    "suggestion": {
        "variants": [{
            "placement": {
                "channel": "HOME"
            },
            "content": {
                "values": [{
                    "locale": "ja-JP",
                    "document": {},
                    "datasources": {}
                }]
            }
        }]
    },
    "targeting": {
       （タイプがユニットのポリモーフィックオブジェクト）
    },
    "scheduling": {
        "activationWindow": {
            "start": "2021-01-01T10:00:00.00Z",
            "end": "2021-01-31T10:00:00.00Z"
        }
    }
}

{
   "suggestion": {
      "variants": [
         {
            "placement": {
               "channel": "HOME"
            },
            "content": {
               "values": [
                  {
                    "locale": "en-US",
                    "document": {
                       "type": "Link",
                       "src": "<ドキュメントへのリンクのプレースホルダー>"
                    },
                    "datasources": {
                       "displayText": {
                          "primaryText": "Example notification title.",
                          "secondaryText": "Example notification text.",
                          "action": {
                              "type": "SkillConnection",
                              "uri": "connection://AMAZON.ColdLaunch/1?provider=amzn1.ask.skill.12345",
                              "input": {}
                          }                          
                       },
                       "background": {
                          "backgroundImageSource": "https://www.example.com/image.jpg"
                       }                       
                    }
                  },
                  {
                    "locale": "ja-JP",
                    "document": {
                       "type": "Link",
                       "src": "<ドキュメントへのリンクのプレースホルダー>"
                    },
                    "datasources": {
                       "displayText": {
                          "primaryText": "サンプルの通知タイトルです。",
                          "secondaryText": "サンプルの通知テキストです。",
                          "action": {
                              "type": "SkillConnection",
                              "uri": "connection://AMAZON.ColdLaunch/1?provider=amzn1.ask.skill.12345",
                              "input": {}
                          }                             
                       },
                       "background": {
                          "backgroundImageSource": "https://www.example.com/image.jpg"
                       }                         
                    }
                  }
                ]
            }
        }]
   },
   "targeting": {
      "type": "UNITS",
      "values": [
        {
           "id": "amzn1.alexa.unit.did.101"
        },
                {
           "id": "amzn1.alexa.unit.did.102"
        }
      ]
   },
   "scheduling": {
      "activationWindow": {
         "start": "2021-01-01T10:00:00.00Z",
         "end": "2021-01-31T10:00:00.00Z"
      }
   }
}

{
    "campaignId": "campaign.id.1",
    "suggestion": {
        "variants": [{
            "placement": {
                "channel": "HOME"
            },
            "content": {
                "values": [{
                        "locale": "en-US",
                        "document": {
                            "type": "Link",
                            "src": "<ドキュメントへのリンクのプレースホルダー>"
                        },
                        "datasources": {
                            "displayText": {
                                "primaryText": "Example notification title.",
                                "secondaryText": "Example notification text.",
                                "action": {
                                    "type": "SkillConnection",
                                    "uri": "connection://AMAZON.ColdLaunch/1?provider=amzn1.ask.skill.12345",
                                    "input": {}
                                }
                            },
                            "background": {
                                "backgroundImageSource": "https://www.example.com/image.jpg"
                            }
                        }
                    },
                    {
                        "locale": "ja-JP",
                        "document": {
                            "type": "Link",
                            "src": "<ドキュメントへのリンクのプレースホルダー>"
                        },
                        "datasources": {
                            "displayText": {
                                "primaryText": "サンプルの通知タイトルです。",
                                "secondaryText": "サンプルの通知テキストです。",
                                "action": {
                                    "type": "SkillConnection",
                                    "uri": "connection://AMAZON.ColdLaunch/1?provider=amzn1.ask.skill.12345",
                                    "input": {}
                                }
                            },
                            "background": {
                                "backgroundImageSource": "https://www.example.com/image.jpg"
                            }
                        }
                    }
                ]
            }
        }]
    },
    "targeting": {
        "type": "UNITS",
        "values": [{
            "id": "amzn1.alexa.unit.did.unitId"
        }]
    },
    "scheduling": {
        "activationWindow": {
            "start": "2021-01-01T10:00:00.00Z",
            "end": "2021-01-31T10:00:00.00Z"
        }
    },
    "validationStatus": {
        "value": "APPROVED",
        "reason": "Explanation"
    }
}

{
   "results": [
      {
         "campaignId": "campaignId",
         "suggestion": {
            "variants": [{
               "placement": {
                  "channel": "HOME"
               },
               "content": {
                  "values": [{
                     "locale": "en-US",
                     "document": {},
                     "datasources": {}
                  }]
               }
            }]          
         },
         "targeting": {
            （タイプがユニットのポリモーフィックオブジェクト）
         },
         "scheduling": {
            "activationWindow": {
               "start": "2021-01-01T10:00:00.00Z",
               "end": "2021-01-31T10:00:00.00Z"
            }
         },
         "validationStatus": {
            "value": "string enum",   // IN_PROGRESS、APPROVED、REJECTED
            "reason": "Explanation"
         }
     },
     {
        ... （別のキャンペーンおよびステータス）...
     }
   ],
   "paginationContext": {
      "nextToken": "someToken.3"
   }
}

{
    "results": [{
        "campaignId": "sample-id",
        "validationStatus": {
            "value": "IN_PROGRESS",
            "reason": "Explanation"
        },
        "suggestion": {
            "variants": [{
                "placement": {
                    "channel": "HOME"
                },
                "content": {
                    "values": [{
                            "locale": "en-US",
                            "document": {
                                "type": "Link",
                                "src": "<ドキュメントへのリンクのプレースホルダー>"
                            },
                            "datasources": {
                                "displayText": {
                                    "primaryText": "Light and warm patio breakfast",
                                    "secondaryText": "Breakfast is served until 11:30 am!"
                                }
                            }
                        },
                        {
                            "locale": "ja-JP",
                            "document": {
                                "type": "Link",
                                "src": "<ドキュメントへのリンクのプレースホルダー>"
                            },
                            "datasources": {
                                "displayText": {
                                    "primaryText": "明るく暖かいテラスで朝食を",
                                    "secondaryText": "朝食は午前11:30までご利用いただけます。"
                                }
                            },
                            "background": {
                                "backgroundImageSource": "https://url-of-image.jpg"
                            }
                        }
                    ]
                }
            }]
        },
        "targeting": {
            "type": "UNITS",
            "values": [{
                "id": "amzn1.alexa.unit.did.unitId"
            }]
        },
        "scheduling": {
            "activationWindow": {
                "start": "2021-01-01T10:00:00.00Z",
                "end": "2021-01-31T10:00:00.00Z"
            }
        }
    }],
    "paginationContext": {
        "nextToken": "someToken.2"
    }
}

{
  "suggestion": {
    "variants": [
      {
        "placement": {
          "channel": "HOME"
        },
        "content": {
          "values": [
            {
              "locale": "ja-JP",
              "document": {
                "type": "Link",
                "src": "doc://alexa/apl/documents/home/cards/textWrapping"
              },
              "datasources": {
                "displayText": {
                  "headerText": "テキスト折り返しのヘッダー",
                  "primaryText": "テキスト折り返しの第1テキスト",
                  "secondaryText": "テキスト折り返しの第2テキスト",
                  "hintText": "テキスト折り返しのヒントテキスト",
                  "tertiaryText": "第3テキスト"
                },
                "background": {
                  "backgroundImageSource": "https://www.example.com/images/image-to-display.jpg"
                },
                "attribution": {
                  "attributionText": "attributionTextのテキスト",
                  "attributionImageSource": "https://www.example.com/images/attribution-image-to-display.jpg"
                }
              }
            }
          ]
        }
      }
    ]
  },
  "targeting": {
    "type": "UNITS",
    "values": [
      {
        "id": "amzn1.alexa.unit.did.XXXX"
      }
    ]
  },
  "scheduling": {
    "activationWindow": {
      "start": "2022-02-01T21:07:46.90Z",
      "end": "2022-02-08T03:07:46.90Z"
    }
  }
}

{
  "suggestion": {
    "variants": [
      {
        "placement": {
          "channel": "HOME"
        },
        "content": {
          "values": [
            {
              "locale": "ja-JP",
              "document": {
                "type": "Link",
                "src": "doc://alexa/apl/documents/home/cards/media"
              },
              "datasources": {
                "displayText": {
                  "headerText": "メディアサムネイルのヘッダー",
                  "primaryText": "メディアサムネイルの第1テキスト",
                  "secondaryText": "メディアサムネイルの第2テキスト",
                  "tertiaryText": "第3テキスト",
                  "hintText": "メディアサムネイルのヒントテキスト"
                },
                "background": {
                  "backgroundImageSource": "https://www.example.com/images/image-to-display.jpg"
                },
                "thumbnail": {
                  "thumbnailImageSource": "https://www.example.com/images/thumbnail-to-display.jpg"
                },
                "attribution": {
                  "attributionText": "attributionTextのテキスト",
                  "attributionImageSource": "https://attributionImage.png"
                }
              }
            }
          ]
        }
      }
    ]
  },
  "targeting": {
    "type": "UNITS",
    "values": [
      {
        "id": "amzn1.alexa.unit.did.XXXX"
      }
    ]
  },
  "scheduling": {
    "activationWindow": {
      "start": "2022-02-01T21:07:46.90Z",
      "end": "2022-02-04T03:07:46.90Z"
    }
  }
}

{
  "suggestion": {
    "variants": [
      {
        "placement": {
          "channel": "HOME"
        },
        "content": {
          "values": [
            {
              "locale": "ja-JP",
              "document": {
                "type": "Link",
                "src": "doc://alexa/apl/documents/home/cards/rating"
              },
              "datasources": {
                "displayText": {
                  "headerText": "スキルテンプレートのヘッダー",
                  "primaryText": "スキルテンプレートの第1テキスト",
                  "ratingNumber": 5,
                  "ratingText": "12345678",
                  "hintText": "スキルテンプレートのヒントテキスト"
                },
                "thumbnail": {
                  "thumbnailImageSource": "https://www.example.com/images/thumbnail-to-display.jpg"
                },
                "background": {
                  "backgroundImageSource": "https://www.example.com/images/image-to-display.jpg"
                }
              </span>}
            }
          ]
        }
      }
    ]
  },
  "targeting": {
    "type": "UNITS",
    "values": [
      {
        "id": "amzn1.alexa.unit.did.XXXX"
      }
    ]
  },
  "scheduling": {
    "activationWindow": {
      "start": "2022-02-01T21:07:46.90Z",
      "end": "2022-02-08T03:07:46.90Z"
    }
  }
}

{
  "suggestion": {
    "variants": [
      {
        "placement": {
          "channel": "HOME"
        },
        "content": {
          "values": [
            {
              "locale": "ja-JP",
              "document": {
                "type": "Link",
                "src": "doc://alexa/apl/documents/home/cards/suggestedActions"
              },
              "datasources": {
                "displayText": {
                  "headerText": "ヘッダーテキスト",
                  "listItems": [
                    {
                      "hintText": "項目1のヒントテキスト",
                      "thumbnailSource": "https://www.example.com/images/whiskAndPaper.jpg"
                    },
                    {
                      "hintText": "項目2のヒントテキスト",
                      "thumbnailSource": "https://www.example.com/images/calendar.jpg"
                    },
                    {
                      "hintText": "項目3のヒントテキスト",
                      "thumbnailSource": "https://www.example.com/images/alarmClockAndPlant.png"
                    }
                  ],
                  "action": {
                    "type": "SkillConnection",
                    "uri": "connection://AMAZON.ColdLaunch/1?provider=amzn1.ask.skill.1",
                    "input": {}
                  }
                },
                "background": {
                  "backgroundImageSource": "https://www.example.com/images/image-to-display.jpg"
                }
              }
            }
          ]
        }
      }
    ]
  },
  "targeting": {
    "type": "UNITS",
    "values": [
      {
        "id": "amzn1.alexa.unit.did.XXXX"
      }
    ]
  },
  "scheduling": {
    "activationWindow": {
      "start": "2023-11-16T18:54:00.00Z",
      "end": "2023-12-24T18:00:00.00Z"
    }
  }
}

{
  "suggestion": {
    "variants": [
      {
        "placement": {
          "channel": "HOME"
        },
        "content": {
          "values": [
            {
              "locale": "ja-JP",
              "document": {
                "type": "Link",
                "src": "doc://alexa/apl/documents/home/cards/primePhoto"
              },
              "datasources": {
                "displayText": {
                  "headerText": "この日の例",
                  "primaryText": "第1テキスト",
                  "hintText": "ヒントテキスト",
                  "action": {
                    "type": "SkillConnection",
                    "uri": "connection://AMAZON.ColdLaunch/1?provider=amzn1.ask.skill.1",
                    "input": {}
                  }
                },
                "background": {
                  "backgroundImageSource": "https://www.example.com/images/image-to-display.jpg"
                }
              }
            }
          ]
        }
      }
    ]
  },
  "targeting": {
    "type": "UNITS",
    "values": [
      {
        "id": "amzn1.alexa.unit.did.XXXX"
      }
    ]
  },
  "scheduling": {
    "activationWindow": {
      "start": "2023-11-16T18:54:00.00Z",
      "end": "2023-12-24T18:00:00.00Z"
    }
  }
}

{
  "suggestion": {
    "variants": [
      {
        "placement": {
          "channel": "HOME"
        },
        "content": {
          "values": [
            {
              "locale": "ja-JP",
              "document": {
                "type": "Link",
                "src": "doc://alexa/apl/documents/home/cards/selectedPhoto"
              },
              "datasources": {
                "displayText": {
                  "primaryText": "第1テキスト",
                  "secondaryText": "第2テキスト",
                  "hintText": "ヒントテキスト",
                  "action": {
                    "type": "SkillConnection",
                    "uri": "connection://AMAZON.ColdLaunch/1?provider=amzn1.ask.skill.1",
                    "input": {}
                  }
                },
                "background": {
                  "backgroundImageSource": "https://www.example.com/images/image-to-display.jpg"
                }
              }
            }
          ]
        }
      }
    ]
  },
  "targeting": {
    "type": "UNITS",
    "values": [
      {
        "id": "amzn1.alexa.unit.did.XXXX"
      }
    ]
  },
  "scheduling": {
    "activationWindow": {
      "start": "2023-11-16T18:54:00.00Z",
      "end": "2023-12-24T18:00:00.00Z"
    }
  }
}