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%（10 進数 0.07）を表します。
performanceGoalString

string

重要業績評価指標（KPI）の文字列。空でもかまいません。長さが 100 文字以下で、UTF-8 でエンコードされている必要があります。

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_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 の推定コード。

Methods

create

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

delete

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

get

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

list

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

listAssignedTargetingOptions

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

patch

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