REST Resource: advertisers.lineItems

リソース: 広告申込情報

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 さまざまな環境向けに販売されるリアルタイム ビッダー オーディオ広告
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 が次の場合）:
    • 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 ～ 100,000 の範囲で指定する必要があります。

たとえば、ポストクリック コンバージョンの 50% をトラッキングするには、値を 50,000 に設定します。
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 iOS プラットフォームです。
ANDROID Android プラットフォーム

Methods

bulkEditLineItemAssignedTargetingOptions

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

bulkListLineItemAssignedTargetingOptions

 複数のターゲティング タイプで広告申込情報に割り当てられたターゲティング オプションを一覧表示します。

create

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

delete

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

generateDefault

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

get

 広告申込情報を取得します。

list

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

patch

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