Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions clients/line-bot-insight-client/.openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,16 @@ src/main/java/com/linecorp/bot/insight/model/GetMessageEventResponseMessage.java
src/main/java/com/linecorp/bot/insight/model/GetMessageEventResponseOverview.java
src/main/java/com/linecorp/bot/insight/model/GetNumberOfFollowersResponse.java
src/main/java/com/linecorp/bot/insight/model/GetNumberOfMessageDeliveriesResponse.java
src/main/java/com/linecorp/bot/insight/model/GetRichMenuInsightDailyResponse.java
src/main/java/com/linecorp/bot/insight/model/GetRichMenuInsightDailyResponseBounds.java
src/main/java/com/linecorp/bot/insight/model/GetRichMenuInsightDailyResponseClick.java
src/main/java/com/linecorp/bot/insight/model/GetRichMenuInsightDailyResponseDailyMetrics.java
src/main/java/com/linecorp/bot/insight/model/GetRichMenuInsightDailyResponseImpression.java
src/main/java/com/linecorp/bot/insight/model/GetRichMenuInsightSummaryResponse.java
src/main/java/com/linecorp/bot/insight/model/GetRichMenuInsightSummaryResponseBounds.java
src/main/java/com/linecorp/bot/insight/model/GetRichMenuInsightSummaryResponseClick.java
src/main/java/com/linecorp/bot/insight/model/GetRichMenuInsightSummaryResponseImpression.java
src/main/java/com/linecorp/bot/insight/model/GetRichMenuInsightSummaryResponseMetrics.java
src/main/java/com/linecorp/bot/insight/model/GetStatisticsPerUnitResponse.java
src/main/java/com/linecorp/bot/insight/model/GetStatisticsPerUnitResponseClick.java
src/main/java/com/linecorp/bot/insight/model/GetStatisticsPerUnitResponseMessage.java
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@
import com.linecorp.bot.insight.model.GetMessageEventResponse;
import com.linecorp.bot.insight.model.GetNumberOfFollowersResponse;
import com.linecorp.bot.insight.model.GetNumberOfMessageDeliveriesResponse;
import com.linecorp.bot.insight.model.GetRichMenuInsightDailyResponse;
import com.linecorp.bot.insight.model.GetRichMenuInsightSummaryResponse;
import com.linecorp.bot.insight.model.GetStatisticsPerUnitResponse;
import java.net.URI;
import java.util.concurrent.CompletableFuture;
Expand Down Expand Up @@ -87,6 +89,48 @@ CompletableFuture<Result<GetNumberOfFollowersResponse>> getNumberOfFollowers(
CompletableFuture<Result<GetNumberOfMessageDeliveriesResponse>> getNumberOfMessageDeliveries(
@Query("date") String date);

/**
* Get rich menu insight daily Gets rich menu statistics broken down by day for the specified
* period, for a rich menu created via the Messaging API. Returns the daily impression count for
* the whole rich menu and the daily click count for each tappable area. When the total number of
* unique clicks during the period is below the privacy threshold, only &#x60;richMenuId&#x60; is
* returned and the other fields are omitted.
*
* @param richMenuId ID of the rich menu created via the Messaging API. (required)
* @param from Start date of the aggregation period (inclusive). Must be within the most recent 3
* years. Format: yyyyMMdd (e.g. 20260213) Time zone: UTC+9 (required)
* @param to End date of the aggregation period (inclusive). The end date can be specified for up
* to 99 days after the start date. Format: yyyyMMdd (e.g. 20260215) Time zone: UTC+9
* (required)
* @see <a
* href="https://developers.line.biz/en/reference/messaging-api/#get-rich-menu-insight-daily">Get
* rich menu insight daily Documentation</a>
*/
@GET("/v2/bot/insight/richmenu/{richMenuId}/daily")
CompletableFuture<Result<GetRichMenuInsightDailyResponse>> getRichMenuInsightDaily(
@Path("richMenuId") String richMenuId, @Query("from") String from, @Query("to") String to);

/**
* Get rich menu insight summary Gets a summary of rich menu statistics for the specified period,
* for a rich menu created via the Messaging API. Returns the total impression count for the whole
* rich menu and the click count for each tappable area, aggregated over the entire period as a
* single result. When the total number of unique clicks during the period is below the privacy
* threshold, only &#x60;richMenuId&#x60; is returned and the other fields are omitted.
*
* @param richMenuId ID of the rich menu created via the Messaging API. (required)
* @param from Start date of the aggregation period (inclusive). Must be within the most recent 3
* years. Format: yyyyMMdd (e.g. 20260213) Time zone: UTC+9 (required)
* @param to End date of the aggregation period (inclusive). The end date can be specified for up
* to 396 days after the start date. Format: yyyyMMdd (e.g. 20260215) Time zone: UTC+9
* (required)
* @see <a
* href="https://developers.line.biz/en/reference/messaging-api/#get-rich-menu-insight-summary">Get
* rich menu insight summary Documentation</a>
*/
@GET("/v2/bot/insight/richmenu/{richMenuId}/summary")
CompletableFuture<Result<GetRichMenuInsightSummaryResponse>> getRichMenuInsightSummary(
@Path("richMenuId") String richMenuId, @Query("from") String from, @Query("to") String to);

/**
* You can check the per-unit statistics of how users interact with push messages and multicast
* messages sent from your LINE Official Account.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
/*
* Copyright 2023 LINE Corporation
*
* LINE Corporation licenses this file to you under the Apache License,
* version 2.0 (the "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*/

/**
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech Do not edit the class manually.
*/
package com.linecorp.bot.insight.model;



import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.List;

/** Daily impression and click statistics for a rich menu created via the Messaging API. */
@JsonInclude(Include.NON_NULL)
@javax.annotation.Generated(value = "com.linecorp.bot.codegen.LineJavaCodegenGenerator")
public record GetRichMenuInsightDailyResponse(
/** Rich menu ID. */
@JsonProperty("richMenuId") String richMenuId,
/**
* Start date (JST) of the period actually covered by the returned metrics. Format: yyyyMMdd
* (e.g. 20260213).
*/
@JsonProperty("metricsFrom") String metricsFrom,
/**
* End date (JST) of the period actually covered by the returned metrics. Format: yyyyMMdd (e.g.
* 20260215).
*/
@JsonProperty("metricsTo") String metricsTo,
/** Get impression */
@JsonProperty("impression") GetRichMenuInsightDailyResponseImpression impression,
/** Daily click metrics for each tappable area of the rich menu. */
@JsonProperty("clicks") List<GetRichMenuInsightDailyResponseClick> clicks) {

public static class Builder {
private String richMenuId;
private String metricsFrom;
private String metricsTo;
private GetRichMenuInsightDailyResponseImpression impression;
private List<GetRichMenuInsightDailyResponseClick> clicks;

public Builder(String richMenuId) {

this.richMenuId = richMenuId;
}

public Builder metricsFrom(String metricsFrom) {
this.metricsFrom = metricsFrom;
return this;
}

public Builder metricsTo(String metricsTo) {
this.metricsTo = metricsTo;
return this;
}

public Builder impression(GetRichMenuInsightDailyResponseImpression impression) {
this.impression = impression;
return this;
}

public Builder clicks(List<GetRichMenuInsightDailyResponseClick> clicks) {
this.clicks = clicks;
return this;
}

public GetRichMenuInsightDailyResponse build() {
return new GetRichMenuInsightDailyResponse(
richMenuId, metricsFrom, metricsTo, impression, clicks);
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
/*
* Copyright 2023 LINE Corporation
*
* LINE Corporation licenses this file to you under the Apache License,
* version 2.0 (the "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*/

/**
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech Do not edit the class manually.
*/
package com.linecorp.bot.insight.model;



import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
import com.fasterxml.jackson.annotation.JsonProperty;

/** Target area of the metrics, represented by the top-left coordinate, width, and height. */
@JsonInclude(Include.NON_NULL)
@javax.annotation.Generated(value = "com.linecorp.bot.codegen.LineJavaCodegenGenerator")
public record GetRichMenuInsightDailyResponseBounds(
/** The x coordinate of the top-left corner of the target area. */
@JsonProperty("x") Integer x,
/** The y coordinate of the top-left corner of the target area. */
@JsonProperty("y") Integer y,
/** The width of the target area. */
@JsonProperty("width") Integer width,
/** The height of the target area. */
@JsonProperty("height") Integer height) {

public static class Builder {
private Integer x;
private Integer y;
private Integer width;
private Integer height;

public Builder(Integer x, Integer y, Integer width, Integer height) {

this.x = x;

this.y = y;

this.width = width;

this.height = height;
}

public GetRichMenuInsightDailyResponseBounds build() {
return new GetRichMenuInsightDailyResponseBounds(x, y, width, height);
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
/*
* Copyright 2023 LINE Corporation
*
* LINE Corporation licenses this file to you under the Apache License,
* version 2.0 (the "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*/

/**
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech Do not edit the class manually.
*/
package com.linecorp.bot.insight.model;



import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.List;

/** Daily click metrics for a single tappable area of the rich menu. */
@JsonInclude(Include.NON_NULL)
@javax.annotation.Generated(value = "com.linecorp.bot.codegen.LineJavaCodegenGenerator")
public record GetRichMenuInsightDailyResponseClick(
/** Get bounds */
@JsonProperty("bounds") GetRichMenuInsightDailyResponseBounds bounds,
/** Per-day click metrics for the target area. */
@JsonProperty("metrics") List<GetRichMenuInsightDailyResponseDailyMetrics> metrics) {

public static class Builder {
private GetRichMenuInsightDailyResponseBounds bounds;
private List<GetRichMenuInsightDailyResponseDailyMetrics> metrics;

public Builder(
GetRichMenuInsightDailyResponseBounds bounds,
List<GetRichMenuInsightDailyResponseDailyMetrics> metrics) {

this.bounds = bounds;

this.metrics = metrics;
}

public GetRichMenuInsightDailyResponseClick build() {
return new GetRichMenuInsightDailyResponseClick(bounds, metrics);
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
/*
* Copyright 2023 LINE Corporation
*
* LINE Corporation licenses this file to you under the Apache License,
* version 2.0 (the "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*/

/**
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech Do not edit the class manually.
*/
package com.linecorp.bot.insight.model;



import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
import com.fasterxml.jackson.annotation.JsonProperty;

/** Aggregated number of events and unique users for a single day. */
@JsonInclude(Include.NON_NULL)
@javax.annotation.Generated(value = "com.linecorp.bot.codegen.LineJavaCodegenGenerator")
public record GetRichMenuInsightDailyResponseDailyMetrics(
/** The date (JST) of these metrics. Format: yyyyMMdd (e.g. 20260213). */
@JsonProperty("date") String date,
/** Number of impressions or clicks on this day. */
@JsonProperty("count") Long count,
/** Approximate number of unique users who triggered an impression or click on this day. */
@JsonProperty("uniqueUsers") Long uniqueUsers) {

public static class Builder {
private String date;
private Long count;
private Long uniqueUsers;

public Builder(String date, Long count, Long uniqueUsers) {

this.date = date;

this.count = count;

this.uniqueUsers = uniqueUsers;
}

public GetRichMenuInsightDailyResponseDailyMetrics build() {
return new GetRichMenuInsightDailyResponseDailyMetrics(date, count, uniqueUsers);
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
/*
* Copyright 2023 LINE Corporation
*
* LINE Corporation licenses this file to you under the Apache License,
* version 2.0 (the "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*/

/**
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech Do not edit the class manually.
*/
package com.linecorp.bot.insight.model;



import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.List;

/** Daily impression metrics for the whole rich menu. */
@JsonInclude(Include.NON_NULL)
@javax.annotation.Generated(value = "com.linecorp.bot.codegen.LineJavaCodegenGenerator")
public record GetRichMenuInsightDailyResponseImpression(
/** Per-day impression metrics. */
@JsonProperty("metrics") List<GetRichMenuInsightDailyResponseDailyMetrics> metrics) {

public static class Builder {
private List<GetRichMenuInsightDailyResponseDailyMetrics> metrics;

public Builder(List<GetRichMenuInsightDailyResponseDailyMetrics> metrics) {

this.metrics = metrics;
}

public GetRichMenuInsightDailyResponseImpression build() {
return new GetRichMenuInsightDailyResponseImpression(metrics);
}
}
}
Loading