REST Resource: advertisers.lineItems

リソース: LineItem

1 つの広告申込情報

JSON 表現 
{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "insertionOrderId": string,
  "lineItemId": string,
  "displayName": string,
  "lineItemType": enum (LineItemType),
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "partnerCosts": [
    {
      object (PartnerCost)
    }
  ],
  "flight": {
    object (LineItemFlight)
  },
  "budget": {
    object (LineItemBudget)
  },
  "pacing": {
    object (Pacing)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "partnerRevenueModel": {
    object (PartnerRevenueModel)
  },
  "conversionCounting": {
    object (ConversionCountingConfig)
  },
  "creativeIds": [
    string
  ],
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "integrationDetails": {
    object (IntegrationDetails)
  },
  "inventorySourceIds": [
    string
  ],
  "targetingExpansion": {
    object (TargetingExpansionConfig)
  },
  "warningMessages": [
    enum (LineItemWarningMessage)
  ],
  "mobileApp": {
    object (MobileApp)
  },
  "reservationType": enum (ReservationType),
  "excludeNewExchanges": boolean
}
フィールド
name

string

出力専用。広告申込情報のリソース名。
advertiserId

string (int64 format)

出力専用。広告申込情報が属する広告主の一意の ID。
campaignId

string (int64 format)

出力専用。広告申込情報が属するキャンペーンの一意の ID。
insertionOrderId

string (int64 format)

必須。変更不可。広告申込情報が属する広告掲載オーダーの一意の ID。
lineItemId

string (int64 format)

出力専用。広告申込情報の一意の ID。システムによって割り当てられます。
displayName

string

必須。広告申込情報の表示名。

UTF-8 でエンコードし、最大サイズを 240 バイトにする必要があります。
lineItemType

enum (LineItemType)

必須。変更不可。広告申込情報のタイプ。
entityStatus

enum (EntityStatus)

必須。広告申込情報で予算を消化して広告枠に入札できるかどうかを制御します。

  • lineItems.create メソッドの場合、ENTITY_STATUS_DRAFT のみを使用できます。広告申込情報を有効にするには、lineItems.patch メソッドを使用して、作成後にステータスを ENTITY_STATUS_ACTIVE に更新します。
  • 広告申込情報のステータスを他のステータスから ENTITY_STATUS_DRAFT に戻すことはできません。
  • 広告申込情報の親広告掲載オーダーが有効でない場合、広告申込情報のステータスは [ENTITY_STATUS_ACTIVE] であっても予算を使うことはできません。
updateTime

string (Timestamp format)

出力専用。広告申込情報が最後に更新されたときのタイムスタンプ。システムによって割り当てられます。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
partnerCosts[]

object (PartnerCost)

広告申込情報に関連付けられたパートナー費用。

lineItems.create メソッドに指定されていない場合、または指定されていない場合、新しく作成された広告申込情報は親広告掲載オーダーからパートナー費用を継承します。
flight

object (LineItemFlight)

必須。広告申込情報の掲載期間の開始時間と終了時間。
budget

object (LineItemBudget)

必須。広告申込情報の予算割り当て設定。
pacing

object (Pacing)

必須。広告申込情報の予算消化ペースの設定。
frequencyCap

object (FrequencyCap)

必須。広告申込情報のインプレッションのフリークエンシー キャップ設定。

上限数を割り当てる場合は、この設定オブジェクトの maxImpressions フィールドを使用する必要があります。
partnerRevenueModel

object (PartnerRevenueModel)

必須。広告申込情報のパートナー収益モデルの設定。
conversionCounting

object (ConversionCountingConfig)

広告申込情報のコンバージョン トラッキング設定。
creativeIds[]

string (int64 format)

広告申込情報に関連付けられているクリエイティブの ID。
bidStrategy

object (BiddingStrategy)

必須。広告申込情報の入札戦略。
integrationDetails

object (IntegrationDetails)

広告申込情報の統合の詳細。
inventorySourceIds[]

string (int64 format)

広告申込情報に割り当てられている非公開の広告枠ソースの ID。
targetingExpansion

object (TargetingExpansionConfig)

広告申込情報の最適化されたターゲティングの設定。

この設定は、自動入札を使用し、有効なオーディエンス リストをターゲットにしているディスプレイ、動画、オーディオの広告申込情報にのみ適用されます。
warningMessages[]

enum (LineItemWarningMessage)

出力専用。広告申込情報によって生成された警告メッセージ。この警告によって広告申込情報の保存が妨げられることはありませんが、広告申込情報の配信がブロックされる場合があります。
mobileApp

object (MobileApp)

広告申込情報で宣伝するモバイルアプリ。

これは、lineItemType が LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL または LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL の場合にのみ適用されます。
reservationType

enum (ReservationType)

出力専用。広告申込情報の予約タイプ。
excludeNewExchanges

boolean

広告申込情報で新しいエクスチェンジを自動的にターゲットから除外するかどうか。このフィールドはデフォルトでは false です。

LineItemType

考えられる広告申込情報のタイプ。

広告申込情報のタイプによって、広告のフォーマットやターゲティング オプションなど、適用できる設定やオプションが決まります。

列挙型
LINE_ITEM_TYPE_UNSPECIFIED

タイプの値が指定されていないか、このバージョンでは不明です。

このタイプの広告申込情報とそのターゲティングは、API を使用して作成または更新することはできません。
LINE_ITEM_TYPE_DISPLAY_DEFAULT イメージ広告、HTML5 広告、ネイティブ広告、リッチメディア広告。
LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL アプリのインストールを促進するディスプレイ広告。
LINE_ITEM_TYPE_VIDEO_DEFAULT さまざまな環境向けに CPM ベースで販売される動画広告。
LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL アプリのインストールを促進する動画広告。
LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INVENTORY

モバイルアプリ広告枠に配信されるディスプレイ広告。

このタイプの広告申込情報とそのターゲティングは、API を使用して作成または更新することはできません。
LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INVENTORY

モバイルアプリ広告枠に配信される動画広告。

このタイプの広告申込情報とそのターゲティングは、API を使用して作成または更新することはできません。
LINE_ITEM_TYPE_AUDIO_DEFAULT さまざまな環境向けに販売される RTB オーディオ広告。
LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP OTT 広告掲載オーダーに表示されるオーバー ザ トップ広告。このタイプは、広告掲載オーダーが insertionOrderType（OVER_THE_TOP）の広告申込情報にのみ適用されます。

LineItemFlight

広告申込情報の有効期間を制御する設定です。

JSON 表現 
{
  "flightDateType": enum (LineItemFlightDateType),
  "dateRange": {
    object (DateRange)
  },
  "triggerId": string
}
フィールド
flightDateType

enum (LineItemFlightDateType)

必須。広告申込情報の掲載期間のタイプ。
dateRange

object (DateRange)

広告申込情報の掲載期間の開始日と終了日。親広告主のタイムゾーンを基準にして解決されます。

  • flightDateType が LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM の場合は必須です。それ以外の場合は出力のみ。
  • 新しい掲載期間を作成する際は、startDate と endDate の両方を将来の日付にする必要があります。
  • 過去の startDate が設定された既存のフライトの endDate は変更可能ですが、startDate は不変です。
  • endDate は startDate 以降で、どちらも 2037 年より前の日付にする必要があります。
triggerId

string (int64 format)

広告申込情報に関連付けられている手動トリガーの ID。

  • flightDateType が LINE_ITEM_FLIGHT_DATE_TYPE_TRIGGER の場合は必須です。それ以外の場合は設定しないでください。
  • 設定すると、広告申込情報の掲載期間は親広告掲載オーダーから継承されます。
  • 選択したトリガーが親広告掲載オーダーの掲載期間内で有効になると、有効な広告申込情報の費用が発生します。

警告: 手動トリガーを使用している広告申込情報は、ディスプレイとディスプレイで配信されなくなりました。動画 360このフィールドは 2023 年 8 月 1 日に廃止されます。詳しくは、機能サポート終了のお知らせをご覧ください。

LineItemFlightDateType

広告申込情報の掲載期間の種類。

列挙型
LINE_ITEM_FLIGHT_DATE_TYPE_UNSPECIFIED タイプの値が指定されていないか、このバージョンでは不明です。
LINE_ITEM_FLIGHT_DATE_TYPE_INHERITED 広告申込情報の掲載期間は、親広告掲載オーダーから継承されます。
LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM 広告申込情報では独自のカスタムの掲載期間を使用します。
LINE_ITEM_FLIGHT_DATE_TYPE_TRIGGER

広告申込情報でトリガーが使用されている。

警告: 手動トリガーを使用している広告申込情報は、ディスプレイとディスプレイで配信されなくなりました。動画 360この値は 2023 年 8 月 1 日に廃止されます。詳しくは、機能サポート終了のお知らせをご覧ください。

LineItemBudget

予算の割り当て方法を制御する設定です。

JSON 表現 
{
  "budgetAllocationType": enum (LineItemBudgetAllocationType),
  "budgetUnit": enum (BudgetUnit),
  "maxAmount": string
}
フィールド
budgetAllocationType

enum (LineItemBudgetAllocationType)

必須。予算割り当てのタイプ。

LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC は、親広告掲載オーダーで予算の自動割り当てが有効になっている場合にのみ適用されます。
budgetUnit

enum (BudgetUnit)

出力専用。予算単位では、予算が通貨ベースかインプレッション ベースかを指定します。この値は親広告掲載オーダーから継承されます。
maxAmount

string (int64 format)

広告申込情報の最大予算額。0 より大きくする必要があります。

budgetAllocationType が次の場合:

  • LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC。このフィールドは不変で、システムによって設定されます。
  • LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED（budgetUnit が以下の場合）: <ph type="x-smartling-placeholder">
      </ph>
    • BUDGET_UNIT_CURRENCY。このフィールドは、使用できる最大予算額を広告主の通貨のマイクロ単位で表します。たとえば、1500000 は 1.5 標準通貨単位を表します。
    • BUDGET_UNIT_IMPRESSIONS。このフィールドは、配信するインプレッションの最大数を表します。
  • LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED。このフィールドは適用されず、システムで無視されます。

LineItemBudgetAllocationType

考えられる予算配分のタイプ。

列挙型
LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNSPECIFIED タイプの値が指定されていないか、このバージョンでは不明です。
LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC 広告申込情報で予算の自動割り当てが有効になっています。
LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED 広告申込情報には固定の最大予算額が割り当てられます。
LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED この広告申込情報には予算の上限が適用されません。

PartnerRevenueModel

パートナー収益の計算方法を制御する設定です。

JSON 表現 
{
  "markupType": enum (PartnerRevenueModelMarkupType),
  "markupAmount": string
}
フィールド
markupType

enum (PartnerRevenueModelMarkupType)

必須。パートナー収益モデルのマークアップ タイプ。
markupAmount

string (int64 format)

必須。パートナー収益モデルの上乗せ額。0 以上で指定します。

  • markupType が PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM に設定されている場合、このフィールドは CPM マークアップを広告主の通貨のマイクロ単位で表します。たとえば、1500000 は 1.5 標準通貨単位を表します。
  • markupType が PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP に設定されている場合、このフィールドはメディア費用の割合マークアップをミリ秒単位で表します。たとえば、100 は 0.1%（10 進数 0.001）を表します。
  • markupType が PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP に設定されている場合、このフィールドは合計メディア費用の割合の上乗せ額をミリ秒単位で表します。たとえば、100 は 0.1%（10 進数 0.001）を表します。

PartnerRevenueModelMarkupType

パートナー収益モデルで考えられるマークアップ タイプ。

列挙型
PARTNER_REVENUE_MODEL_MARKUP_TYPE_UNSPECIFIED タイプの値が指定されていないか、このバージョンでは不明です。
PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM 固定 CPM に基づいてパートナーの収益を計算する。
PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP

メディア費用の追加料金の割合に基づいてパートナーの収益を計算します。
PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP すべてのパートナー費用とデータ費用を含む、合計メディア費用に対する追加料金の割合に基づいてパートナーの収益を計算します。

ConversionCountingConfig

コンバージョンのカウント方法を管理する設定です。

ポストクリック コンバージョンがすべてカウントされます。ポストビュー コンバージョンのカウントに割合値を設定できます。

JSON 表現 
{
  "postViewCountPercentageMillis": string,
  "floodlightActivityConfigs": [
    {
      object (TrackingFloodlightActivityConfig)
    }
  ]
}
フィールド
postViewCountPercentageMillis

string (int64 format)

カウントするポストビュー コンバージョンの割合（ミリ秒単位）（パーセントの 1/1, 000）。0 ～ 100000 の値にする必要があります。

たとえば、ポストクリック コンバージョンの 50% をトラッキングするには、値を 50000 に設定します。
floodlightActivityConfigs[]

object (TrackingFloodlightActivityConfig)

コンバージョンのトラッキングに使用される Floodlight アクティビティの設定。

カウントされるコンバージョン数は、このフィールドに指定されたすべての Floodlight アクティビティ ID でカウントされたコンバージョンをすべて合計した値です。

TrackingFloodlightActivityConfig

1 つの Floodlight アクティビティ設定の動作を制御する設定です。

JSON 表現 
{
  "floodlightActivityId": string,
  "postClickLookbackWindowDays": integer,
  "postViewLookbackWindowDays": integer
}
フィールド
floodlightActivityId

string (int64 format)

必須。Floodlight アクティビティの ID。
postClickLookbackWindowDays

integer

必須。広告がクリックされてからコンバージョンをカウントできる日数です。0 ～ 90 の値にする必要があります。
postViewLookbackWindowDays

integer

必須。広告が視聴されてから、コンバージョンがカウントされるまでの日数。0 ～ 90 の値にする必要があります。

TargetingExpansionConfig

広告申込情報の最適化されたターゲティングの設定を管理する設定です。

JSON 表現 
{
  "targetingExpansionLevel": enum (TargetingExpansionLevel),
  "excludeFirstPartyAudience": boolean
}
フィールド
targetingExpansionLevel

enum (TargetingExpansionLevel)

必須。最適化されたターゲティングが有効になっているかどうか。

このフィールドでサポートされる値は次のとおりです。

  • NO_EXPANSION: 最適化されたターゲティングが無効になっています
  • LEAST_EXPANSION: 最適化されたターゲティングが有効

このフィールドに他の値を設定した場合は、自動的に LEAST_EXPANSION に設定されます。

NO_EXPANSION はフィールドのデフォルト値であり、フィールドを設定しない場合は自動的に割り当てられます。
excludeFirstPartyAudience
(deprecated)

boolean

ターゲットの拡張でファースト パーティ オーディエンスを除外するかどうかを指定します。

このフィールドは、最適化されたターゲティングのリリースに伴って廃止されました。

このフィールドは false に設定されます。サポートが終了した時点でこのフィールドが true に設定されている場合、この広告申込情報に割り当てられている正のファースト パーティ オーディエンス ターゲティングはすべて、同じファースト パーティ オーディエンスのターゲティング除外に置き換えられ、これらのオーディエンスが引き続き除外されます。

TargetingExpansionLevel

最適化されたターゲティングの設定。

列挙型
TARGETING_EXPANSION_LEVEL_UNSPECIFIED 最適化されたターゲティングの設定が指定されていないか、このバージョンでは不明です。
NO_EXPANSION 最適化されたターゲティングは無効になっています。
LEAST_EXPANSION 最適化されたターゲティングは有効です。
SOME_EXPANSION

これを使用すると、自動的に LEAST_EXPANSION に設定されます。
BALANCED_EXPANSION

これを使用すると、自動的に LEAST_EXPANSION に設定されます。
MORE_EXPANSION

これを使用すると、自動的に LEAST_EXPANSION に設定されます。
MOST_EXPANSION

これを使用すると、自動的に LEAST_EXPANSION に設定されます。

LineItemWarningMessage

広告申込情報によって生成された警告メッセージ。このような警告により、広告申込情報の保存が妨げられることはありませんが、広告申込情報の配信がブロックされる場合があります。

列挙型
LINE_ITEM_WARNING_MESSAGE_UNSPECIFIED 指定されていないか、不明です。
INVALID_FLIGHT_DATES この広告申込情報には無効な掲載期間が設定されています。この広告申込情報は配信されません。
EXPIRED この広告申込情報の終了日は過去の日付になっています。
PENDING_FLIGHT この広告申込情報は今後配信が開始されます。
ALL_PARTNER_ENABLED_EXCHANGES_NEGATIVELY_TARGETED パートナーが有効にしたエクスチェンジはすべてターゲットから除外されます。この広告申込情報は配信されません。
INVALID_INVENTORY_SOURCE ターゲットに設定している有効な広告枠ソースはありません。この広告申込情報は配信されません。
APP_INVENTORY_INVALID_SITE_TARGETING この広告申込情報のアプリとURL ターゲティングにモバイルアプリは含まれません。この広告申込情報タイプでは、チャネル、サイトリスト、またはアプリ ターゲティングにモバイルアプリを含める必要があります。この広告申込情報は配信されません。
APP_INVENTORY_INVALID_AUDIENCE_LISTS この広告申込情報はモバイル ユーザーをターゲットに設定していません。この広告申込情報タイプでは、モバイル ユーザーを含むユーザーリストをターゲットに設定する必要があります。この広告申込情報は配信されません。
NO_VALID_CREATIVE この広告申込情報には有効なクリエイティブが含まれていません。この広告申込情報は配信されません。
PARENT_INSERTION_ORDER_PAUSED この広告申込情報の広告掲載オーダーは一時停止されています。この広告申込情報は配信されません。
PARENT_INSERTION_ORDER_EXPIRED この広告申込情報の広告掲載オーダーの終了日が過去の日付に設定されています。この広告申込情報は配信されません。
NO_POSITIVE_AUDIENCE_LIST_TARGETED この広告申込情報ではオーディエンス リストがターゲットに設定されていません。このため、予算を早く使い切ってしまう可能性があります。
APP_INSTALL_NO_CONVERSION_PIXEL このアプリ インストールの広告申込情報にはコンバージョン ピクセルが設定されていません。
TARGETING_REVOKED_OR_CLOSED_USER_LIST この広告申込情報では、使用できなくなったユーザーリストがターゲットに設定されています。将来的に、広告申込情報は配信されなくなるため、これらのリストをターゲティングから削除することをおすすめします。
APP_INSTALL_NO_OPTIMAL_BIDDING_STRATEGY このアプリ インストールの広告申込情報には最適な入札戦略が設定されていません。
CREATIVE_SIZE_NOT_IN_USE_FOR_TARGETED_DEALS この広告申込情報でターゲットに設定されている取引では、使用されていないクリエイティブ サイズを使用できます。これにより、広告申込情報の配信やパフォーマンスが制限される場合があります。
NO_CREATIVE_FOR_TARGETED_DEALS この広告申込情報には、ターゲットに設定されている取引のクリエイティブが含まれていません。
TARGETING_DEPRECATED_GEO_TARGET この広告申込情報のターゲットはサポートが終了している地域ターゲティングです。
DEPRECATED_FIRST_PARTY_AUDIENCE_EXCLUSION

この広告申込情報では excludeFirstPartyAudience 設定を使用しますが、この設定はサポートが終了し、2023 年 3 月 25 日以降に廃止される予定です。

excludeFirstPartyAudience フィールドの廃止に伴い、2023 年 3 月 25 日までに API 統合を更新し、オーディエンス ターゲティングを使用してファースト パーティ オーディエンスを直接除外してください。

MobileApp

モバイルアプリ インストール広告申込情報で宣伝するモバイルアプリ。

JSON 表現 
{
  "appId": string,
  "platform": enum (Platform),
  "displayName": string,
  "publisher": string
}
フィールド
appId

string

必須。プラットフォーム ストアが提供するアプリの ID。

Android アプリは、Android の Play ストアで使用されるバンドル ID（com.google.android.gm など）で識別されます。

iOS アプリは、Apple の App Store で使用される 9 桁のアプリ ID（422689480 など）で識別されます。
platform

enum (Platform)

出力専用。アプリ プラットフォーム。
displayName

string

出力専用。アプリ名。
publisher

string

出力専用。アプリ パブリッシャー。

プラットフォーム

利用可能なモバイルアプリ プラットフォーム。

列挙型
PLATFORM_UNSPECIFIED プラットフォームが指定されていません。
IOS ダウンロードします
ANDROID Android プラットフォーム。

メソッド

bulkEditLineItemAssignedTargetingOptions

 1 つの広告申込情報のターゲティング オプションを一括編集する。

bulkListLineItemAssignedTargetingOptions

 さまざまなターゲティング タイプで、広告申込情報に割り当てられているターゲティング オプションを一覧表示します。

create

 新しい広告申込情報を作成します。

delete

 広告申込情報を削除します。

generateDefault

 広告掲載オーダーから継承した設定（ターゲティングを含む）と ENTITY_STATUS_DRAFT entity_status を使用して、新しい広告申込情報を作成します。

get

 項目を取得します。

list

 広告主の広告申込情報を一覧表示します。

patch

 既存の広告申込情報を更新します。