REST Resource: advertisers.campaigns

リソース: キャンペーン

1 つのキャンペーン。

JSON 表現 
{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "campaignGoal": {
    object (CampaignGoal)
  },
  "campaignFlight": {
    object (CampaignFlight)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "campaignBudgets": [
    {
      object (CampaignBudget)
    }
  ]
}
フィールド
name

string

出力専用。キャンペーンのリソース名。
advertiserId

string (int64 format)

出力専用。キャンペーンが属する広告主の一意の ID。
campaignId

string (int64 format)

出力専用。キャンペーンの一意の ID。システムによって割り当てられます。
displayName

string

必須。キャンペーンの表示名。

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

enum (EntityStatus)

必須。このキャンペーンの広告掲載オーダーが予算を消化し、広告枠に入札できるかどうかを制御します。

  • 指定できる値は ENTITY_STATUS_ACTIVE、ENTITY_STATUS_ARCHIVED、ENTITY_STATUS_PAUSED です。
  • campaigns.create メソッドでは、ENTITY_STATUS_ARCHIVED は使用できません。
updateTime

string (Timestamp format)

出力専用。キャンペーンが最後に更新されたときのタイムスタンプ。システムによって割り当てられます。

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

object (CampaignGoal)

必須。キャンペーンの目標。
campaignFlight

object (CampaignFlight)

必須。キャンペーンの予算と期間。
frequencyCap

object (FrequencyCap)

必須。キャンペーンのフリークエンシー キャップの設定。
campaignBudgets[]

object (CampaignBudget)

このキャンペーンで利用できる予算のリストです。

このフィールドが設定されていない場合、キャンペーンでは無制限の予算が使用されます。

CampaignGoal

キャンペーンの目標を管理する設定。

JSON 表現 
{
  "campaignGoalType": enum (CampaignGoalType),
  "performanceGoal": {
    object (PerformanceGoal)
  }
}
フィールド
campaignGoalType

enum (CampaignGoalType)

必須。キャンペーン目標のタイプ。
performanceGoal

object (PerformanceGoal)

必須。キャンペーンのパフォーマンス目標。

performanceGoalType に指定できる値は次のとおりです。

  • PERFORMANCE_GOAL_TYPE_CPM
  • PERFORMANCE_GOAL_TYPE_CPC
  • PERFORMANCE_GOAL_TYPE_CPA
  • PERFORMANCE_GOAL_TYPE_CPIAVC
  • PERFORMANCE_GOAL_TYPE_CTR
  • PERFORMANCE_GOAL_TYPE_VIEWABILITY
  • PERFORMANCE_GOAL_TYPE_OTHER

CampaignGoalType

キャンペーンの目標の種類。

列挙型
CAMPAIGN_GOAL_TYPE_UNSPECIFIED このバージョンでは、目標値が指定されていないか不明です。
CAMPAIGN_GOAL_TYPE_APP_INSTALL アプリのインストールやエンゲージメントを促進する。
CAMPAIGN_GOAL_TYPE_BRAND_AWARENESS ブランドや商品の認知度を高める。
CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION オフラインや店舗での売り上げの向上を図ります。
CAMPAIGN_GOAL_TYPE_ONLINE_ACTION オンラインでの行動やアクセスを促進します。

PerformanceGoal

キャンペーンの成果目標を管理する設定。

JSON 表現 
{
  "performanceGoalType": enum (PerformanceGoalType),

  // Union field performance_goal_value can be only one of the following:
  "performanceGoalAmountMicros": string,
  "performanceGoalPercentageMicros": string,
  "performanceGoalString": string
  // End of list of possible types for union field performance_goal_value.
}
フィールド
performanceGoalType

enum (PerformanceGoalType)

必須。掲載結果の目標のタイプ。
共用体フィールド performance_goal_value。必須。特定の performance_goal_type に対応するパフォーマンス目標値。performance_goal_value は次のいずれかになります。
performanceGoalAmountMicros

string (int64 format)

目標金額（広告主の通貨のマイクロ単位）。

performanceGoalType が次のいずれかの場合に有効です。

  • PERFORMANCE_GOAL_TYPE_CPM
  • PERFORMANCE_GOAL_TYPE_CPC
  • PERFORMANCE_GOAL_TYPE_CPA
  • PERFORMANCE_GOAL_TYPE_CPIAVC
  • PERFORMANCE_GOAL_TYPE_VCPM

たとえば、1500000 は通貨の 1.5 標準単位を表します。
performanceGoalPercentageMicros

string (int64 format)

目標の割合の小数値（マイクロ秒単位）。

performanceGoalType が次のいずれかの場合に有効です。

  • PERFORMANCE_GOAL_TYPE_CTR
  • PERFORMANCE_GOAL_TYPE_VIEWABILITY
  • PERFORMANCE_GOAL_TYPE_CLICK_CVR
  • PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR
  • PERFORMANCE_GOAL_TYPE_VTR
  • PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE
  • PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE

たとえば、70000 は 7%（小数点以下 0.07）を表します。
performanceGoalString

string

重要業績評価指標（KPI）の文字列。空にすることもできます。UTF-8 でエンコードし、長さを 100 文字以下にする必要があります。

performanceGoalType が PERFORMANCE_GOAL_TYPE_OTHER に設定されている場合に有効です。

PerformanceGoalType

設定できる掲載結果目標のタイプ。

列挙型
PERFORMANCE_GOAL_TYPE_UNSPECIFIED このバージョンでは、成果目標のタイプが指定されていないか、不明です。
PERFORMANCE_GOAL_TYPE_CPM パフォーマンス目標は CPM（インプレッション単価）で設定されます。
PERFORMANCE_GOAL_TYPE_CPC 成果目標は CPC（クリック単価）で設定されます。
PERFORMANCE_GOAL_TYPE_CPA パフォーマンス目標は CPA（コンバージョン単価）で設定します。
PERFORMANCE_GOAL_TYPE_CTR パフォーマンス目標は、クリック率（CTR）のパーセンテージで設定します。
PERFORMANCE_GOAL_TYPE_VIEWABILITY パフォーマンス目標は視認性の割合で設定されます。
PERFORMANCE_GOAL_TYPE_CPIAVC パフォーマンス目標は CPIAVC（再生完了時に聴取可能かつ視認可能なインプレッション単価）に設定されています。
PERFORMANCE_GOAL_TYPE_CPE パフォーマンス目標は CPE（エンゲージメント単価）で設定されます。
PERFORMANCE_GOAL_TYPE_CPV パフォーマンス目標は CPV（広告視聴単価）で設定されます。
PERFORMANCE_GOAL_TYPE_CLICK_CVR パフォーマンス目標は、クリック単価コンバージョン率（クリックあたりのコンバージョン数）のパーセンテージで設定します。
PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR パフォーマンス目標は、インプレッション コンバージョン率（インプレッションあたりのコンバージョン数）の割合で設定します。
PERFORMANCE_GOAL_TYPE_VCPM パフォーマンス目標は、視認可能なインプレッション単価（VCPM）で設定します。
PERFORMANCE_GOAL_TYPE_VTR パフォーマンス目標は、YouTube 視聴率（インプレッションあたりの YouTube 視聴回数）の割合で設定します。
PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE パフォーマンス目標は、オーディオ完全再生率（インプレッションあたりのオーディオ再生完了率）で設定します。
PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE パフォーマンス目標は、動画の完全再生率（インプレッションあたりの動画の完全再生回数）の割合で設定します。
PERFORMANCE_GOAL_TYPE_OTHER 成果目標が [その他] に設定されている。

CampaignFlight

キャンペーンの予定費用と期間を追跡する設定。

JSON 表現 
{
  "plannedSpendAmountMicros": string,
  "plannedDates": {
    object (DateRange)
  }
}
フィールド
plannedSpendAmountMicros

string (int64 format)

指定された plannedDates でキャンペーンで使用が見込まれる金額。この設定は配信には影響せず、DV360 の管理画面で費用のトラッキングに使用されます。

金額はマイクロ単位です。0 以上の値を指定してください。たとえば、500000000 は、通貨の 500 標準単位を表します。
plannedDates

object (DateRange)

必須。キャンペーンの実施予定日です。親広告主のタイムゾーンを基準に解決されます。

  • ここで指定した日付は配信には影響しません。アラートと警告の生成に使用されます。たとえば、子広告掲載オーダーの配信日がこれらの日付の範囲外の場合、ユーザー インターフェースに警告が表示されます。
  • startDate は必須で、現在以降の日付を指定する必要があります。
  • endDate は省略可能です。指定する場合は、startDate 以降にする必要があります。
  • 指定する日付は 2037 年より前である必要があります。

CampaignBudget

キャンペーン予算の配分方法を制御する設定。

JSON 表現 
{
  "budgetId": string,
  "displayName": string,
  "budgetUnit": enum (BudgetUnit),
  "budgetAmountMicros": string,
  "dateRange": {
    object (DateRange)
  },
  "externalBudgetSource": enum (ExternalBudgetSource),
  "externalBudgetId": string,
  "invoiceGroupingId": string,
  "prismaConfig": {
    object (PrismaConfig)
  }
}
フィールド
budgetId

string (int64 format)

キャンペーン予算の一意の ID。システムによって割り当てられます。新しい予算には設定しないでください。

予算を更新または campaignBudgets に追加するときに含める必要があります。それ以外の場合は、新しい ID が生成されて割り当てられます。
displayName

string

必須。予算の表示名。

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

enum (BudgetUnit)

必須。変更不可。予算を通貨またはインプレッション数で測定するかどうかを指定します。
budgetAmountMicros

string (int64 format)

必須。リンクされた広告掲載オーダー セグメントで予算設定できる合計金額。

金額はマイクロ単位です。0 より大きくする必要があります。たとえば、500000000 は 500 通貨の標準単位を表します。
dateRange

object (DateRange)

必須。キャンペーン予算の期間。リンクされた予算セグメントの期間は、異なる場合があります。親広告主のタイムゾーンを基準にして解決されます。

startDate と endDate の両方は 2037 年より前である必要があります。
externalBudgetSource

enum (ExternalBudgetSource)

必須。予算の外部ソース。
externalBudgetId

string

変更不可。この予算を外部ソースに識別する ID。

このフィールドが設定され、対応する請求プロファイルの請求書の詳細レベルが [予算レベルの PO] に設定されている場合、この予算に対して配信されたすべてのインプレッションの請求書にこの ID が含まれます。

キャンペーンの下で一意である必要があります。
invoiceGroupingId

string

変更不可。同じ請求書に含める予算をグループ化するために使用される ID。

このフィールドが設定され、対応する請求プロファイルの請求書レベルが [予算請求書グループ ID] に設定されている場合、同じ invoiceGroupingId を共有するすべての externalBudgetId が同じ請求書にグループ化されます。
prismaConfig

object (PrismaConfig)

Mediaocean Prisma ツールで使用される追加のメタデータ。

Mediaocean の予算には必須です。

prismaEnabled の広告主様にのみ適用されます。

ExternalBudgetSource

キャンペーンの予算セグメントの外部ソース。

列挙型
EXTERNAL_BUDGET_SOURCE_UNSPECIFIED このバージョンでは、外部予算ソースの値が指定されていないか、不明です。
EXTERNAL_BUDGET_SOURCE_NONE 予算に外部ソースがない。
EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN 予算ソースは Mediaocean です。

PrismaConfig

Mediaocean Prisma ツールに固有の設定。

JSON 表現 
{
  "prismaType": enum (PrismaType),
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "supplier": string
}
フィールド
prismaType

enum (PrismaType)

必須。Prisma 型。
prismaCpeCode

object (PrismaCpeCode)

必須。Mediaocean Prisma ツールの関連するクライアント コード、プロダクト コード、見積もりコード。
supplier

string

必須。事業体がこの予算を割り当てました（DSP、サイトなど）。

PrismaType

Prisma 予算の有効なタイプ。

列挙型
PRISMA_TYPE_UNSPECIFIED このバージョンでタイプが指定されていないか、不明です。
PRISMA_TYPE_DISPLAY 表示タイプ。
PRISMA_TYPE_VIDEO 動画の種類。
PRISMA_TYPE_AUDIO 音声の種類。
PRISMA_TYPE_SOCIAL ソーシャル タイプ。
PRISMA_TYPE_FEE 料金タイプ。

PrismaCpeCode

Google お支払いセンターでは、このコードのコンポーネント フィールドの検索とフィルタリングをサポートしています。

JSON 表現 
{
  "prismaClientCode": string,
  "prismaProductCode": string,
  "prismaEstimateCode": string
}
フィールド
prismaClientCode

string

Prisma クライアント コード。
prismaProductCode

string

Prisma の商品コード。
prismaEstimateCode

string

Prisma 見積りコード。

メソッド

create

 新しいキャンペーンを作成します。

delete

 キャンペーンを完全に削除します。

get

 キャンペーンを取得します。

list

 広告主のキャンペーンを一覧表示します。

listAssignedTargetingOptions

 ターゲティング タイプ別のキャンペーンに割り当てられたターゲティング オプションを一覧表示します。

patch

 既存のキャンペーンを更新します。