REST Resource: advertisers.campaigns

リソース: Campaign

単一のキャンペーン。

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 オンラインでの行動やアクセスを促進します。

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

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