REST Resource: advertisers.campaigns

リソース: Campaign

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)

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

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
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),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "performanceGoalAmountMicros": string,
  "performanceGoalPercentageMicros": string,
  "performanceGoalString": string
  // End of mutually exclusive fields.
}
フィールド
performanceGoalType

enum (PerformanceGoalType)

必須。パフォーマンスの目標のタイプ。
必須。指定された performance_goal_type に対応するパフォーマンスの目標値。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
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)

目標割合の 10 進数表現（マイクロ単位）。

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%（10 進数 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 でキャンペーンが費やすと予想される金額。これは配信を制限するものではなく、ディスプレイ＆ビデオ 360 の管理画面で費用をトラッキングするために使用されます。

金額はマイクロ単位です。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

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

patch

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