
jp.co.yahoo.adsdisplayapi.v14.model.Campaign Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ads-display-api-lib Show documentation
Show all versions of ads-display-api-lib Show documentation
Yahoo! JAPAN Ads Display Ads API library for Java
The newest version!
/*
* Yahoo!広告 ディスプレイ広告 API リファレンス / Yahoo! JAPAN Ads Display Ads API Reference
* Yahoo!広告 ディスプレイ広告 APIのWebサービスについて説明します。 Display Ads API Web Services supported in Yahoo! JAPAN Ads API.
*
* The version of the OpenAPI document: v14
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package jp.co.yahoo.adsdisplayapi.v14.model;
import java.util.Objects;
import java.util.Arrays;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonTypeName;
import com.fasterxml.jackson.annotation.JsonValue;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.util.ArrayList;
import java.util.List;
import jp.co.yahoo.adsdisplayapi.v14.model.CampaignServiceAppOsType;
import jp.co.yahoo.adsdisplayapi.v14.model.CampaignServiceBiddingStrategyConfiguration;
import jp.co.yahoo.adsdisplayapi.v14.model.CampaignServiceBudget;
import jp.co.yahoo.adsdisplayapi.v14.model.CampaignServiceConversionTracker;
import jp.co.yahoo.adsdisplayapi.v14.model.CampaignServiceCustomParameters;
import jp.co.yahoo.adsdisplayapi.v14.model.CampaignServiceIsRemoveFlg;
import jp.co.yahoo.adsdisplayapi.v14.model.CampaignServiceLabel;
import jp.co.yahoo.adsdisplayapi.v14.model.CampaignServiceOptimizer;
import jp.co.yahoo.adsdisplayapi.v14.model.CampaignServiceServingStatus;
import jp.co.yahoo.adsdisplayapi.v14.model.CampaignServiceSkanOptimaizeAdDeliveryEnabled;
import jp.co.yahoo.adsdisplayapi.v14.model.CampaignServiceUserStatus;
import jp.co.yahoo.adsdisplayapi.v14.model.CampaignServiceViewableFrequencyCap;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeName;
/**
* <div lang=\"ja\">Campaignオブジェクトは、キャンペーン情報を表します。</div> <div lang=\"en\">Campaign object describes campaign information.</div>
*/
@ApiModel(description = "Campaignオブジェクトは、キャンペーン情報を表します。 Campaign object describes campaign information. ")
@JsonPropertyOrder({
Campaign.JSON_PROPERTY_ACCOUNT_ID,
Campaign.JSON_PROPERTY_APP_ID,
Campaign.JSON_PROPERTY_APP_NAME,
Campaign.JSON_PROPERTY_BUDGET,
Campaign.JSON_PROPERTY_BIDDING_STRATEGY_CONFIGURATION,
Campaign.JSON_PROPERTY_CAMPAIGN_GOAL,
Campaign.JSON_PROPERTY_CAMPAIGN_ID,
Campaign.JSON_PROPERTY_CAMPAIGN_NAME,
Campaign.JSON_PROPERTY_OPTIMIZER,
Campaign.JSON_PROPERTY_CUSTOM_PARAMETERS,
Campaign.JSON_PROPERTY_APP_OS_TYPE,
Campaign.JSON_PROPERTY_END_DATE,
Campaign.JSON_PROPERTY_END_TIME,
Campaign.JSON_PROPERTY_FEED_ID,
Campaign.JSON_PROPERTY_IS_REMOVE_TRACKING_URL,
Campaign.JSON_PROPERTY_LABELS,
Campaign.JSON_PROPERTY_OPTIMIZATION_SCORE,
Campaign.JSON_PROPERTY_SERVING_STATUS,
Campaign.JSON_PROPERTY_START_DATE,
Campaign.JSON_PROPERTY_START_TIME,
Campaign.JSON_PROPERTY_TRACKING_URL,
Campaign.JSON_PROPERTY_USER_STATUS,
Campaign.JSON_PROPERTY_VIEWABLE_FREQUENCY_CAP,
Campaign.JSON_PROPERTY_CAMPAIGN_DELIVERY_TYPE,
Campaign.JSON_PROPERTY_CREATED_DATE,
Campaign.JSON_PROPERTY_VENDOR_NAME,
Campaign.JSON_PROPERTY_SKAN_OPTIMAIZE_AD_DELIVERY_ENABLED,
Campaign.JSON_PROPERTY_CONVERSION_TRACKER
})
@JsonTypeName("Campaign")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class Campaign {
public static final String JSON_PROPERTY_ACCOUNT_ID = "accountId";
private Long accountId;
public static final String JSON_PROPERTY_APP_ID = "appId";
private String appId;
public static final String JSON_PROPERTY_APP_NAME = "appName";
private String appName;
public static final String JSON_PROPERTY_BUDGET = "budget";
private CampaignServiceBudget budget;
public static final String JSON_PROPERTY_BIDDING_STRATEGY_CONFIGURATION = "biddingStrategyConfiguration";
private CampaignServiceBiddingStrategyConfiguration biddingStrategyConfiguration;
public static final String JSON_PROPERTY_CAMPAIGN_GOAL = "campaignGoal";
private String campaignGoal;
public static final String JSON_PROPERTY_CAMPAIGN_ID = "campaignId";
private Long campaignId;
public static final String JSON_PROPERTY_CAMPAIGN_NAME = "campaignName";
private String campaignName;
public static final String JSON_PROPERTY_OPTIMIZER = "optimizer";
private CampaignServiceOptimizer optimizer;
public static final String JSON_PROPERTY_CUSTOM_PARAMETERS = "customParameters";
private CampaignServiceCustomParameters customParameters;
public static final String JSON_PROPERTY_APP_OS_TYPE = "appOsType";
private CampaignServiceAppOsType appOsType;
public static final String JSON_PROPERTY_END_DATE = "endDate";
private String endDate;
public static final String JSON_PROPERTY_END_TIME = "endTime";
private String endTime;
public static final String JSON_PROPERTY_FEED_ID = "feedId";
private Long feedId;
public static final String JSON_PROPERTY_IS_REMOVE_TRACKING_URL = "isRemoveTrackingUrl";
private CampaignServiceIsRemoveFlg isRemoveTrackingUrl;
public static final String JSON_PROPERTY_LABELS = "labels";
private List labels = null;
public static final String JSON_PROPERTY_OPTIMIZATION_SCORE = "optimizationScore";
private Double optimizationScore;
public static final String JSON_PROPERTY_SERVING_STATUS = "servingStatus";
private CampaignServiceServingStatus servingStatus;
public static final String JSON_PROPERTY_START_DATE = "startDate";
private String startDate;
public static final String JSON_PROPERTY_START_TIME = "startTime";
private String startTime;
public static final String JSON_PROPERTY_TRACKING_URL = "trackingUrl";
private String trackingUrl;
public static final String JSON_PROPERTY_USER_STATUS = "userStatus";
private CampaignServiceUserStatus userStatus;
public static final String JSON_PROPERTY_VIEWABLE_FREQUENCY_CAP = "viewableFrequencyCap";
private CampaignServiceViewableFrequencyCap viewableFrequencyCap;
public static final String JSON_PROPERTY_CAMPAIGN_DELIVERY_TYPE = "campaignDeliveryType";
private String campaignDeliveryType;
public static final String JSON_PROPERTY_CREATED_DATE = "createdDate";
private String createdDate;
public static final String JSON_PROPERTY_VENDOR_NAME = "vendorName";
private String vendorName;
public static final String JSON_PROPERTY_SKAN_OPTIMAIZE_AD_DELIVERY_ENABLED = "skanOptimaizeAdDeliveryEnabled";
private CampaignServiceSkanOptimaizeAdDeliveryEnabled skanOptimaizeAdDeliveryEnabled;
public static final String JSON_PROPERTY_CONVERSION_TRACKER = "conversionTracker";
private CampaignServiceConversionTracker conversionTracker;
public Campaign() {
}
public Campaign accountId(Long accountId) {
this.accountId = accountId;
return this;
}
/**
* <div lang=\"ja\"> アカウントIDです。<br> このフィールドは、リクエストの場合は必須です。 </div> <div lang=\"en\"> Account ID. <br> This field is required in requests. </div>
* @return accountId
**/
@javax.annotation.Nullable
@ApiModelProperty(value = " アカウントIDです。
このフィールドは、リクエストの場合は必須です。 Account ID.
This field is required in requests. ")
@JsonProperty(JSON_PROPERTY_ACCOUNT_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Long getAccountId() {
return accountId;
}
@JsonProperty(JSON_PROPERTY_ACCOUNT_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setAccountId(Long accountId) {
this.accountId = accountId;
}
public Campaign appId(String appId) {
this.appId = appId;
return this;
}
/**
* <div lang=\"ja\"> iOS:アプリIDです。<br> Android:パッケージ名です。<br> このフィールドは、ADD時に省略可能となり、SETおよびREMOVE時は無視されます。<br> ※campaignGoalが「APP_PROMOTION」の場合、ADD時に必須となります。 </div> <div lang=\"en\"> iOS: APP ID.<br> Android: Package name. <br> This field is optional in ADD operation, and will be ignored in SET and REMOVE operation.<br> *If campaignGoal is APP_PROMOTION, this field is required in ADD operation. </div>
* @return appId
**/
@javax.annotation.Nullable
@ApiModelProperty(value = " iOS:アプリIDです。
Android:パッケージ名です。
このフィールドは、ADD時に省略可能となり、SETおよびREMOVE時は無視されます。
※campaignGoalが「APP_PROMOTION」の場合、ADD時に必須となります。 iOS: APP ID.
Android: Package name.
This field is optional in ADD operation, and will be ignored in SET and REMOVE operation.
*If campaignGoal is APP_PROMOTION, this field is required in ADD operation. ")
@JsonProperty(JSON_PROPERTY_APP_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getAppId() {
return appId;
}
@JsonProperty(JSON_PROPERTY_APP_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setAppId(String appId) {
this.appId = appId;
}
public Campaign appName(String appName) {
this.appName = appName;
return this;
}
/**
* <div lang=\"ja\"> アプリの名称です。<br> このフィールドは、ADD時に省略可能となり、SETおよびREMOVE時は無視されます。<br> ※campaignGoalが「APP_PROMOTION」の場合、ADD時に必須となります。 </div> <div lang=\"en\"> App name. <br> This field is optional in ADD operation, and will be ignored in SET and REMOVE operation.<br> *If campaignGoal is APP_PROMOTION, this field is required in ADD operation. </div>
* @return appName
**/
@javax.annotation.Nullable
@ApiModelProperty(value = " アプリの名称です。
このフィールドは、ADD時に省略可能となり、SETおよびREMOVE時は無視されます。
※campaignGoalが「APP_PROMOTION」の場合、ADD時に必須となります。 App name.
This field is optional in ADD operation, and will be ignored in SET and REMOVE operation.
*If campaignGoal is APP_PROMOTION, this field is required in ADD operation. ")
@JsonProperty(JSON_PROPERTY_APP_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getAppName() {
return appName;
}
@JsonProperty(JSON_PROPERTY_APP_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setAppName(String appName) {
this.appName = appName;
}
public Campaign budget(CampaignServiceBudget budget) {
this.budget = budget;
return this;
}
/**
* Get budget
* @return budget
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_BUDGET)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public CampaignServiceBudget getBudget() {
return budget;
}
@JsonProperty(JSON_PROPERTY_BUDGET)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setBudget(CampaignServiceBudget budget) {
this.budget = budget;
}
public Campaign biddingStrategyConfiguration(CampaignServiceBiddingStrategyConfiguration biddingStrategyConfiguration) {
this.biddingStrategyConfiguration = biddingStrategyConfiguration;
return this;
}
/**
* Get biddingStrategyConfiguration
* @return biddingStrategyConfiguration
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_BIDDING_STRATEGY_CONFIGURATION)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public CampaignServiceBiddingStrategyConfiguration getBiddingStrategyConfiguration() {
return biddingStrategyConfiguration;
}
@JsonProperty(JSON_PROPERTY_BIDDING_STRATEGY_CONFIGURATION)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setBiddingStrategyConfiguration(CampaignServiceBiddingStrategyConfiguration biddingStrategyConfiguration) {
this.biddingStrategyConfiguration = biddingStrategyConfiguration;
}
public Campaign campaignGoal(String campaignGoal) {
this.campaignGoal = campaignGoal;
return this;
}
/**
* <div lang=\"ja\"> キャンペーン目的です。<br> ADD時、このフィールドは必須となります。<br> SETおよびREMOVE時、このフィールドは無視されます。<br> ※指定可能な値は、AccountAuthorityServiceのGET操作で得られるAccountAuthorityのauthoritiesフィールドをご確認ください。<br> </div> <div lang=\"en\"> Campaign goal.<br> In ADD operation, this field is required.<br> In SET and REMOVE operation, this field will be ignored.<br> * Available values can be referred to authorities field of AccountAuthority object obtained by GET operation of AccountAuthorityService.<br> </div>
* @return campaignGoal
**/
@javax.annotation.Nullable
@ApiModelProperty(value = " キャンペーン目的です。
ADD時、このフィールドは必須となります。
SETおよびREMOVE時、このフィールドは無視されます。
※指定可能な値は、AccountAuthorityServiceのGET操作で得られるAccountAuthorityのauthoritiesフィールドをご確認ください。
Campaign goal.
In ADD operation, this field is required.
In SET and REMOVE operation, this field will be ignored.
* Available values can be referred to authorities field of AccountAuthority object obtained by GET operation of AccountAuthorityService.
")
@JsonProperty(JSON_PROPERTY_CAMPAIGN_GOAL)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getCampaignGoal() {
return campaignGoal;
}
@JsonProperty(JSON_PROPERTY_CAMPAIGN_GOAL)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setCampaignGoal(String campaignGoal) {
this.campaignGoal = campaignGoal;
}
public Campaign campaignId(Long campaignId) {
this.campaignId = campaignId;
return this;
}
/**
* <div lang=\"ja\"> キャンペーンIDです。<br> このフィールドはSETおよびREMOVE時に必須となり、ADD時に無視されます。 </div> <div lang=\"en\"> Campaign ID.<br> This field is required in SET and REMOVE operation, and will be ignored in ADD operation. </div>
* @return campaignId
**/
@javax.annotation.Nullable
@ApiModelProperty(value = " キャンペーンIDです。
このフィールドはSETおよびREMOVE時に必須となり、ADD時に無視されます。 Campaign ID.
This field is required in SET and REMOVE operation, and will be ignored in ADD operation. ")
@JsonProperty(JSON_PROPERTY_CAMPAIGN_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Long getCampaignId() {
return campaignId;
}
@JsonProperty(JSON_PROPERTY_CAMPAIGN_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setCampaignId(Long campaignId) {
this.campaignId = campaignId;
}
public Campaign campaignName(String campaignName) {
this.campaignName = campaignName;
return this;
}
/**
* <div lang=\"ja\"> キャンペーン名です。<br> このフィールドは、ADD時は必須、SET時は省略可能となり、REMOVE時は無視されます。 </div> <div lang=\"en\"> Campaign name.<br> This field is required in ADD operation, is optional in SET operation, and will be ignored in REMOVE operation. </div>
* @return campaignName
**/
@javax.annotation.Nullable
@ApiModelProperty(value = " キャンペーン名です。
このフィールドは、ADD時は必須、SET時は省略可能となり、REMOVE時は無視されます。 Campaign name.
This field is required in ADD operation, is optional in SET operation, and will be ignored in REMOVE operation. ")
@JsonProperty(JSON_PROPERTY_CAMPAIGN_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getCampaignName() {
return campaignName;
}
@JsonProperty(JSON_PROPERTY_CAMPAIGN_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setCampaignName(String campaignName) {
this.campaignName = campaignName;
}
public Campaign optimizer(CampaignServiceOptimizer optimizer) {
this.optimizer = optimizer;
return this;
}
/**
* Get optimizer
* @return optimizer
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_OPTIMIZER)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public CampaignServiceOptimizer getOptimizer() {
return optimizer;
}
@JsonProperty(JSON_PROPERTY_OPTIMIZER)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setOptimizer(CampaignServiceOptimizer optimizer) {
this.optimizer = optimizer;
}
public Campaign customParameters(CampaignServiceCustomParameters customParameters) {
this.customParameters = customParameters;
return this;
}
/**
* Get customParameters
* @return customParameters
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_CUSTOM_PARAMETERS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public CampaignServiceCustomParameters getCustomParameters() {
return customParameters;
}
@JsonProperty(JSON_PROPERTY_CUSTOM_PARAMETERS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setCustomParameters(CampaignServiceCustomParameters customParameters) {
this.customParameters = customParameters;
}
public Campaign appOsType(CampaignServiceAppOsType appOsType) {
this.appOsType = appOsType;
return this;
}
/**
* Get appOsType
* @return appOsType
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_APP_OS_TYPE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public CampaignServiceAppOsType getAppOsType() {
return appOsType;
}
@JsonProperty(JSON_PROPERTY_APP_OS_TYPE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setAppOsType(CampaignServiceAppOsType appOsType) {
this.appOsType = appOsType;
}
public Campaign endDate(String endDate) {
this.endDate = endDate;
return this;
}
/**
* <div lang=\"ja\"> 終了日です。<br> このフィールドは、ADDおよびSET時に省略可能となり、REMOVE時に無視されます。<br> ※endTimeが指定されている場合、ADDおよびSET時に必須となります。<br> ※フォーマット:yyyyMMdd </div> <div lang=\"en\"> End date.<br> This field is optional in ADD and SET operation, and will be ignored in REMOVE operation.<br> If endTime is specified, This field is required in ADD and SET operation.<br> *format: yyyyMMdd </div>
* @return endDate
**/
@javax.annotation.Nullable
@ApiModelProperty(value = " 終了日です。
このフィールドは、ADDおよびSET時に省略可能となり、REMOVE時に無視されます。
※endTimeが指定されている場合、ADDおよびSET時に必須となります。
※フォーマット:yyyyMMdd End date.
This field is optional in ADD and SET operation, and will be ignored in REMOVE operation.
If endTime is specified, This field is required in ADD and SET operation.
*format: yyyyMMdd ")
@JsonProperty(JSON_PROPERTY_END_DATE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getEndDate() {
return endDate;
}
@JsonProperty(JSON_PROPERTY_END_DATE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setEndDate(String endDate) {
this.endDate = endDate;
}
public Campaign endTime(String endTime) {
this.endTime = endTime;
return this;
}
/**
* <div lang=\"ja\"> 終了時刻です。<br> このフィールドは、ADDおよびSET時に省略可能となり、REMOVE時に無視されます。<br> ※フォーマット:HHmm </div> <div lang=\"en\"> End time.<br> This field is optional in ADD and SET operation, and will be ignored in REMOVE operation.<br> * Format: HHmm </div>
* @return endTime
**/
@javax.annotation.Nullable
@ApiModelProperty(value = " 終了時刻です。
このフィールドは、ADDおよびSET時に省略可能となり、REMOVE時に無視されます。
※フォーマット:HHmm End time.
This field is optional in ADD and SET operation, and will be ignored in REMOVE operation.
* Format: HHmm ")
@JsonProperty(JSON_PROPERTY_END_TIME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getEndTime() {
return endTime;
}
@JsonProperty(JSON_PROPERTY_END_TIME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setEndTime(String endTime) {
this.endTime = endTime;
}
public Campaign feedId(Long feedId) {
this.feedId = feedId;
return this;
}
/**
* <div lang=\"ja\"> フィードIDです。<br> このフィールドは、ADD時に省略可能となり、SETおよびREMOVE時に無視されます。<br> ※campaignGoalが「ITEM_LIST」の場合、ADD時に必須となります。 </div> <div lang=\"en\"> Feed ID.<br> This field is optional in ADD operation, and will be ignored in SET and REMOVE operation. <br> *If campaignGoal is ITEM_LIST, this field is required in ADD operation. </div>
* @return feedId
**/
@javax.annotation.Nullable
@ApiModelProperty(value = " フィードIDです。
このフィールドは、ADD時に省略可能となり、SETおよびREMOVE時に無視されます。
※campaignGoalが「ITEM_LIST」の場合、ADD時に必須となります。 Feed ID.
This field is optional in ADD operation, and will be ignored in SET and REMOVE operation.
*If campaignGoal is ITEM_LIST, this field is required in ADD operation. ")
@JsonProperty(JSON_PROPERTY_FEED_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Long getFeedId() {
return feedId;
}
@JsonProperty(JSON_PROPERTY_FEED_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setFeedId(Long feedId) {
this.feedId = feedId;
}
public Campaign isRemoveTrackingUrl(CampaignServiceIsRemoveFlg isRemoveTrackingUrl) {
this.isRemoveTrackingUrl = isRemoveTrackingUrl;
return this;
}
/**
* Get isRemoveTrackingUrl
* @return isRemoveTrackingUrl
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_IS_REMOVE_TRACKING_URL)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public CampaignServiceIsRemoveFlg getIsRemoveTrackingUrl() {
return isRemoveTrackingUrl;
}
@JsonProperty(JSON_PROPERTY_IS_REMOVE_TRACKING_URL)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setIsRemoveTrackingUrl(CampaignServiceIsRemoveFlg isRemoveTrackingUrl) {
this.isRemoveTrackingUrl = isRemoveTrackingUrl;
}
public Campaign labels(List labels) {
this.labels = labels;
return this;
}
public Campaign addLabelsItem(CampaignServiceLabel labelsItem) {
if (this.labels == null) {
this.labels = new ArrayList<>();
}
this.labels.add(labelsItem);
return this;
}
/**
* Get labels
* @return labels
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_LABELS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getLabels() {
return labels;
}
@JsonProperty(JSON_PROPERTY_LABELS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setLabels(List labels) {
this.labels = labels;
}
public Campaign optimizationScore(Double optimizationScore) {
this.optimizationScore = optimizationScore;
return this;
}
/**
* <div lang=\"ja\">最適化スコアです。<br> 最適化スコアは、0.0から1.0の範囲の値を返却します。<br> このフィールドは、レスポンスの際に返却されますが、リクエストの際には無視されます。</div> <div lang=\"en\">Optimization score.<br> Optimization score returns a value ranging from 0.0 to 1.0.<br> Although this field will be returned in the response, it will be ignored on input.</div>
* @return optimizationScore
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "最適化スコアです。
最適化スコアは、0.0から1.0の範囲の値を返却します。
このフィールドは、レスポンスの際に返却されますが、リクエストの際には無視されます。 Optimization score.
Optimization score returns a value ranging from 0.0 to 1.0.
Although this field will be returned in the response, it will be ignored on input. ")
@JsonProperty(JSON_PROPERTY_OPTIMIZATION_SCORE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Double getOptimizationScore() {
return optimizationScore;
}
@JsonProperty(JSON_PROPERTY_OPTIMIZATION_SCORE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setOptimizationScore(Double optimizationScore) {
this.optimizationScore = optimizationScore;
}
public Campaign servingStatus(CampaignServiceServingStatus servingStatus) {
this.servingStatus = servingStatus;
return this;
}
/**
* Get servingStatus
* @return servingStatus
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_SERVING_STATUS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public CampaignServiceServingStatus getServingStatus() {
return servingStatus;
}
@JsonProperty(JSON_PROPERTY_SERVING_STATUS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setServingStatus(CampaignServiceServingStatus servingStatus) {
this.servingStatus = servingStatus;
}
public Campaign startDate(String startDate) {
this.startDate = startDate;
return this;
}
/**
* <div lang=\"ja\"> 開始日です。<br> このフィールドは、ADDおよびSET時に省略可能となり、REMOVE時に無視されます。<br> ※startTimeが指定されている場合、ADDおよびSET時に必須となります。<br> ※フォーマット:yyyyMMdd </div> <div lang=\"en\"> Start date.<br> This field is optional in ADD and SET operation, and will be ignored in REMOVE operation.<br> If startTime is specified, This field is required in ADD and SET operation.<br> *format: yyyyMMdd </div>
* @return startDate
**/
@javax.annotation.Nullable
@ApiModelProperty(value = " 開始日です。
このフィールドは、ADDおよびSET時に省略可能となり、REMOVE時に無視されます。
※startTimeが指定されている場合、ADDおよびSET時に必須となります。
※フォーマット:yyyyMMdd Start date.
This field is optional in ADD and SET operation, and will be ignored in REMOVE operation.
If startTime is specified, This field is required in ADD and SET operation.
*format: yyyyMMdd ")
@JsonProperty(JSON_PROPERTY_START_DATE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getStartDate() {
return startDate;
}
@JsonProperty(JSON_PROPERTY_START_DATE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setStartDate(String startDate) {
this.startDate = startDate;
}
public Campaign startTime(String startTime) {
this.startTime = startTime;
return this;
}
/**
* <div lang=\"ja\"> 開始時刻です。<br> このフィールドは、ADDおよびSET時に省略可能となり、REMOVE時に無視されます。<br> ※フォーマット:HHmm </div> <div lang=\"en\"> Start time.<br> This field is optional in ADD and SET operation, and will be ignored in REMOVE operation.<br> * Format: HHmm </div>
* @return startTime
**/
@javax.annotation.Nullable
@ApiModelProperty(value = " 開始時刻です。
このフィールドは、ADDおよびSET時に省略可能となり、REMOVE時に無視されます。
※フォーマット:HHmm Start time.
This field is optional in ADD and SET operation, and will be ignored in REMOVE operation.
* Format: HHmm ")
@JsonProperty(JSON_PROPERTY_START_TIME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getStartTime() {
return startTime;
}
@JsonProperty(JSON_PROPERTY_START_TIME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setStartTime(String startTime) {
this.startTime = startTime;
}
public Campaign trackingUrl(String trackingUrl) {
this.trackingUrl = trackingUrl;
return this;
}
/**
* <div lang=\"ja\">トラッキングURLです。<br> ADD時およびSET時、このフィールドは省略可能となります。<br> ※SET時、こちらが審査中の場合、編集はできません。</div> <div lang=\"en\">Tracking URL.<br> This field is optional in ADD and SET operation.<br> *In SET operation, cannot update it when this field is in editorial review.</div>
* @return trackingUrl
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "トラッキングURLです。
ADD時およびSET時、このフィールドは省略可能となります。
※SET時、こちらが審査中の場合、編集はできません。 Tracking URL.
This field is optional in ADD and SET operation.
*In SET operation, cannot update it when this field is in editorial review. ")
@JsonProperty(JSON_PROPERTY_TRACKING_URL)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getTrackingUrl() {
return trackingUrl;
}
@JsonProperty(JSON_PROPERTY_TRACKING_URL)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setTrackingUrl(String trackingUrl) {
this.trackingUrl = trackingUrl;
}
public Campaign userStatus(CampaignServiceUserStatus userStatus) {
this.userStatus = userStatus;
return this;
}
/**
* Get userStatus
* @return userStatus
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_USER_STATUS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public CampaignServiceUserStatus getUserStatus() {
return userStatus;
}
@JsonProperty(JSON_PROPERTY_USER_STATUS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setUserStatus(CampaignServiceUserStatus userStatus) {
this.userStatus = userStatus;
}
public Campaign viewableFrequencyCap(CampaignServiceViewableFrequencyCap viewableFrequencyCap) {
this.viewableFrequencyCap = viewableFrequencyCap;
return this;
}
/**
* Get viewableFrequencyCap
* @return viewableFrequencyCap
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_VIEWABLE_FREQUENCY_CAP)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public CampaignServiceViewableFrequencyCap getViewableFrequencyCap() {
return viewableFrequencyCap;
}
@JsonProperty(JSON_PROPERTY_VIEWABLE_FREQUENCY_CAP)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setViewableFrequencyCap(CampaignServiceViewableFrequencyCap viewableFrequencyCap) {
this.viewableFrequencyCap = viewableFrequencyCap;
}
public Campaign campaignDeliveryType(String campaignDeliveryType) {
this.campaignDeliveryType = campaignDeliveryType;
return this;
}
/**
* <div lang=\"ja\"> キャンペーン掲載タイプです。<br> このフィールドは、ADDおよびSET時に省略可能となり、REMOVE時に無視されます。<br> CampaignDeliveryTypeを指定してのキャンペーン作成は、一部の利用者向けの機能となります。 </div> <div lang=\"en\"> Campaign delivery type.<br> This field is optional in ADD and SET operation, and will be ignored in REMOVE operation.<br> Creating a campaign with the CampaignDeliveryType specified is a function for some users. </div>
* @return campaignDeliveryType
**/
@javax.annotation.Nullable
@ApiModelProperty(value = " キャンペーン掲載タイプです。
このフィールドは、ADDおよびSET時に省略可能となり、REMOVE時に無視されます。
CampaignDeliveryTypeを指定してのキャンペーン作成は、一部の利用者向けの機能となります。 Campaign delivery type.
This field is optional in ADD and SET operation, and will be ignored in REMOVE operation.
Creating a campaign with the CampaignDeliveryType specified is a function for some users. ")
@JsonProperty(JSON_PROPERTY_CAMPAIGN_DELIVERY_TYPE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getCampaignDeliveryType() {
return campaignDeliveryType;
}
@JsonProperty(JSON_PROPERTY_CAMPAIGN_DELIVERY_TYPE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setCampaignDeliveryType(String campaignDeliveryType) {
this.campaignDeliveryType = campaignDeliveryType;
}
public Campaign createdDate(String createdDate) {
this.createdDate = createdDate;
return this;
}
/**
* <div lang=\"ja\">キャンペーンが作成された日です。<br>※フォーマット:yyyyMMdd</div> <div lang=\"en\">Date of Campaign made.<br>* Format: yyyyMMdd</div>
* @return createdDate
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "キャンペーンが作成された日です。
※フォーマット:yyyyMMdd Date of Campaign made.
* Format: yyyyMMdd ")
@JsonProperty(JSON_PROPERTY_CREATED_DATE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getCreatedDate() {
return createdDate;
}
@JsonProperty(JSON_PROPERTY_CREATED_DATE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setCreatedDate(String createdDate) {
this.createdDate = createdDate;
}
public Campaign vendorName(String vendorName) {
this.vendorName = vendorName;
return this;
}
/**
* <div lang=\"ja\"> キャンペーンの広告効果測定ツールのベンダー名です。キャンペーン目的「アプリ訴求」の場合にのみ設定されます。<br> このフィールドはキャンペーン作成後、最初にリンク先URLを設定した広告が作成された時に設定されます。<br> キャンペーンに紐づく広告のリンク先URLには、このベンダー名に対応する広告効果測定ツールのURLのみが指定できます。<br> ADD時およびSET時、<code>APPSFLYER</code>, <code>ADJUST</code>, <code>SINGULAR</code>, <code>KOCHAVA</code>, および <code>NONE</code> のみ指定可能です。 </div> <div lang=\"en\"> Vendor name of tracking tool for the campaign. It will be set only when the campaign goal is \"app promotion.\"<br> This field will be set when the first ad with destination URL is created after creating the campaign.<br> Only the tracking tool URL corresponds to this tool vendor name can be specified for the destination URL of the ad linked to the campaign.<br> Only <code>APPSFLYER</code>, <code>ADJUST</code>, <code>SINGULAR</code>, <code>KOCHAVA</code>, and <code>NONE</code> can be specified in ADD and SET operation. </div>
* @return vendorName
**/
@javax.annotation.Nullable
@ApiModelProperty(value = " キャンペーンの広告効果測定ツールのベンダー名です。キャンペーン目的「アプリ訴求」の場合にのみ設定されます。
このフィールドはキャンペーン作成後、最初にリンク先URLを設定した広告が作成された時に設定されます。
キャンペーンに紐づく広告のリンク先URLには、このベンダー名に対応する広告効果測定ツールのURLのみが指定できます。
ADD時およびSET時、APPSFLYER
, ADJUST
, SINGULAR
, KOCHAVA
, および NONE
のみ指定可能です。 Vendor name of tracking tool for the campaign. It will be set only when the campaign goal is \"app promotion.\"
This field will be set when the first ad with destination URL is created after creating the campaign.
Only the tracking tool URL corresponds to this tool vendor name can be specified for the destination URL of the ad linked to the campaign.
Only APPSFLYER
, ADJUST
, SINGULAR
, KOCHAVA
, and NONE
can be specified in ADD and SET operation. ")
@JsonProperty(JSON_PROPERTY_VENDOR_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getVendorName() {
return vendorName;
}
@JsonProperty(JSON_PROPERTY_VENDOR_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setVendorName(String vendorName) {
this.vendorName = vendorName;
}
public Campaign skanOptimaizeAdDeliveryEnabled(CampaignServiceSkanOptimaizeAdDeliveryEnabled skanOptimaizeAdDeliveryEnabled) {
this.skanOptimaizeAdDeliveryEnabled = skanOptimaizeAdDeliveryEnabled;
return this;
}
/**
* Get skanOptimaizeAdDeliveryEnabled
* @return skanOptimaizeAdDeliveryEnabled
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_SKAN_OPTIMAIZE_AD_DELIVERY_ENABLED)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public CampaignServiceSkanOptimaizeAdDeliveryEnabled getSkanOptimaizeAdDeliveryEnabled() {
return skanOptimaizeAdDeliveryEnabled;
}
@JsonProperty(JSON_PROPERTY_SKAN_OPTIMAIZE_AD_DELIVERY_ENABLED)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setSkanOptimaizeAdDeliveryEnabled(CampaignServiceSkanOptimaizeAdDeliveryEnabled skanOptimaizeAdDeliveryEnabled) {
this.skanOptimaizeAdDeliveryEnabled = skanOptimaizeAdDeliveryEnabled;
}
public Campaign conversionTracker(CampaignServiceConversionTracker conversionTracker) {
this.conversionTracker = conversionTracker;
return this;
}
/**
* Get conversionTracker
* @return conversionTracker
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_CONVERSION_TRACKER)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public CampaignServiceConversionTracker getConversionTracker() {
return conversionTracker;
}
@JsonProperty(JSON_PROPERTY_CONVERSION_TRACKER)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setConversionTracker(CampaignServiceConversionTracker conversionTracker) {
this.conversionTracker = conversionTracker;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Campaign campaign = (Campaign) o;
return Objects.equals(this.accountId, campaign.accountId) &&
Objects.equals(this.appId, campaign.appId) &&
Objects.equals(this.appName, campaign.appName) &&
Objects.equals(this.budget, campaign.budget) &&
Objects.equals(this.biddingStrategyConfiguration, campaign.biddingStrategyConfiguration) &&
Objects.equals(this.campaignGoal, campaign.campaignGoal) &&
Objects.equals(this.campaignId, campaign.campaignId) &&
Objects.equals(this.campaignName, campaign.campaignName) &&
Objects.equals(this.optimizer, campaign.optimizer) &&
Objects.equals(this.customParameters, campaign.customParameters) &&
Objects.equals(this.appOsType, campaign.appOsType) &&
Objects.equals(this.endDate, campaign.endDate) &&
Objects.equals(this.endTime, campaign.endTime) &&
Objects.equals(this.feedId, campaign.feedId) &&
Objects.equals(this.isRemoveTrackingUrl, campaign.isRemoveTrackingUrl) &&
Objects.equals(this.labels, campaign.labels) &&
Objects.equals(this.optimizationScore, campaign.optimizationScore) &&
Objects.equals(this.servingStatus, campaign.servingStatus) &&
Objects.equals(this.startDate, campaign.startDate) &&
Objects.equals(this.startTime, campaign.startTime) &&
Objects.equals(this.trackingUrl, campaign.trackingUrl) &&
Objects.equals(this.userStatus, campaign.userStatus) &&
Objects.equals(this.viewableFrequencyCap, campaign.viewableFrequencyCap) &&
Objects.equals(this.campaignDeliveryType, campaign.campaignDeliveryType) &&
Objects.equals(this.createdDate, campaign.createdDate) &&
Objects.equals(this.vendorName, campaign.vendorName) &&
Objects.equals(this.skanOptimaizeAdDeliveryEnabled, campaign.skanOptimaizeAdDeliveryEnabled) &&
Objects.equals(this.conversionTracker, campaign.conversionTracker);
}
@Override
public int hashCode() {
return Objects.hash(accountId, appId, appName, budget, biddingStrategyConfiguration, campaignGoal, campaignId, campaignName, optimizer, customParameters, appOsType, endDate, endTime, feedId, isRemoveTrackingUrl, labels, optimizationScore, servingStatus, startDate, startTime, trackingUrl, userStatus, viewableFrequencyCap, campaignDeliveryType, createdDate, vendorName, skanOptimaizeAdDeliveryEnabled, conversionTracker);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class Campaign {\n");
sb.append(" accountId: ").append(toIndentedString(accountId)).append("\n");
sb.append(" appId: ").append(toIndentedString(appId)).append("\n");
sb.append(" appName: ").append(toIndentedString(appName)).append("\n");
sb.append(" budget: ").append(toIndentedString(budget)).append("\n");
sb.append(" biddingStrategyConfiguration: ").append(toIndentedString(biddingStrategyConfiguration)).append("\n");
sb.append(" campaignGoal: ").append(toIndentedString(campaignGoal)).append("\n");
sb.append(" campaignId: ").append(toIndentedString(campaignId)).append("\n");
sb.append(" campaignName: ").append(toIndentedString(campaignName)).append("\n");
sb.append(" optimizer: ").append(toIndentedString(optimizer)).append("\n");
sb.append(" customParameters: ").append(toIndentedString(customParameters)).append("\n");
sb.append(" appOsType: ").append(toIndentedString(appOsType)).append("\n");
sb.append(" endDate: ").append(toIndentedString(endDate)).append("\n");
sb.append(" endTime: ").append(toIndentedString(endTime)).append("\n");
sb.append(" feedId: ").append(toIndentedString(feedId)).append("\n");
sb.append(" isRemoveTrackingUrl: ").append(toIndentedString(isRemoveTrackingUrl)).append("\n");
sb.append(" labels: ").append(toIndentedString(labels)).append("\n");
sb.append(" optimizationScore: ").append(toIndentedString(optimizationScore)).append("\n");
sb.append(" servingStatus: ").append(toIndentedString(servingStatus)).append("\n");
sb.append(" startDate: ").append(toIndentedString(startDate)).append("\n");
sb.append(" startTime: ").append(toIndentedString(startTime)).append("\n");
sb.append(" trackingUrl: ").append(toIndentedString(trackingUrl)).append("\n");
sb.append(" userStatus: ").append(toIndentedString(userStatus)).append("\n");
sb.append(" viewableFrequencyCap: ").append(toIndentedString(viewableFrequencyCap)).append("\n");
sb.append(" campaignDeliveryType: ").append(toIndentedString(campaignDeliveryType)).append("\n");
sb.append(" createdDate: ").append(toIndentedString(createdDate)).append("\n");
sb.append(" vendorName: ").append(toIndentedString(vendorName)).append("\n");
sb.append(" skanOptimaizeAdDeliveryEnabled: ").append(toIndentedString(skanOptimaizeAdDeliveryEnabled)).append("\n");
sb.append(" conversionTracker: ").append(toIndentedString(conversionTracker)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces
* (except the first line).
*/
private String toIndentedString(Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy