Interface Campaign

Campaignオブジェクトは、キャンペーン情報を表します。
Campaign object describes campaign information.

Hierarchy

  • Campaign

Properties

accountId?: null | number
アカウントIDです。
このフィールドは、リクエストの場合は必須です。
Account ID.
This field is required in requests.

Memberof

Campaign

appId?: null | string
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.

Memberof

Campaign

appName?: null | string
アプリの名称です。
このフィールドは、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.

Memberof

Campaign

Memberof

Campaign

biddingStrategyConfiguration?: null | CampaignServiceBiddingStrategyConfiguration

Memberof

Campaign

Memberof

Campaign

campaignDeliveryType?: null | string
キャンペーン掲載タイプです。
このフィールドは、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.

Memberof

Campaign

campaignGoal?: null | string
キャンペーン目的です。
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.

Memberof

Campaign

campaignId?: null | number
キャンペーンIDです。
このフィールドはSETおよびREMOVE時に必須となり、ADD時に無視されます。
Campaign ID.
This field is required in SET and REMOVE operation, and will be ignored in ADD operation.

Memberof

Campaign

campaignName?: null | string
キャンペーン名です。
このフィールドは、ADD時は必須、SET時は省略可能となり、REMOVE時は無視されます。
Campaign name.
This field is required in ADD operation, is optional in SET operation, and will be ignored in REMOVE operation.

Memberof

Campaign

conversionTracker?: null | CampaignServiceConversionTracker

Memberof

Campaign

createdDate?: null | string
キャンペーンが作成された日です。
※フォーマット:yyyyMMdd
Date of Campaign made.
* Format: yyyyMMdd

Memberof

Campaign

customParameters?: null | display.CampaignServiceCustomParameters

Memberof

Campaign

endDate?: null | string
終了日です。
このフィールドは、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

Memberof

Campaign

endTime?: null | string
終了時刻です。
このフィールドは、ADDおよびSET時に省略可能となり、REMOVE時に無視されます。
※フォーマット:HHmm
End time.
This field is optional in ADD and SET operation, and will be ignored in REMOVE operation.
* Format: HHmm

Memberof

Campaign

feedId?: null | number
フィード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.

Memberof

Campaign

isRemoveTrackingUrl?: null | CampaignServiceIsRemoveFlg

Memberof

Campaign

labels?: null | display.CampaignServiceLabel[]

Memberof

Campaign

optimizationScore?: null | number
最適化スコアです。
最適化スコアは、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.

Memberof

Campaign

optimizer?: null | CampaignServiceOptimizer

Memberof

Campaign

servingStatus?: null | display.CampaignServiceServingStatus

Memberof

Campaign

skanOptimaizeAdDeliveryEnabled?: null | CampaignServiceSkanOptimaizeAdDeliveryEnabled

Memberof

Campaign

startDate?: null | string
開始日です。
このフィールドは、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

Memberof

Campaign

startTime?: null | string
開始時刻です。
このフィールドは、ADDおよびSET時に省略可能となり、REMOVE時に無視されます。
※フォーマット:HHmm
Start time.
This field is optional in ADD and SET operation, and will be ignored in REMOVE operation.
* Format: HHmm

Memberof

Campaign

trackingUrl?: null | string
トラッキング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.

Memberof

Campaign

Memberof

Campaign

vendorName?: null | string
キャンペーンの広告効果測定ツールのベンダー名です。キャンペーン目的「アプリ訴求」の場合にのみ設定されます。
このフィールドはキャンペーン作成後、最初にリンク先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.

Memberof

Campaign

viewableFrequencyCap?: null | CampaignServiceViewableFrequencyCap

Memberof

Campaign