- リソース: Campaign
- CampaignGoal
- CampaignGoalType
- PerformanceGoal
- PerformanceGoalType
- CampaignFlight
- CampaignBudget
- ExternalBudgetSource
- PrismaConfig
- PrismaType
- PrismaCpeCode
- メソッド
リソース: キャンペーン
1 つのキャンペーン。
JSON 表現 |
---|
{ "name": string, "advertiserId": string, "campaignId": string, "displayName": string, "entityStatus": enum ( |
フィールド | |
---|---|
name |
出力のみ。キャンペーンのリソース名。 |
advertiserId |
出力のみ。キャンペーンが属する広告主の一意の ID。 |
campaignId |
出力のみ。キャンペーンの一意の ID です。システムによって割り当てられます。 |
displayName |
必須。キャンペーンの表示名。 UTF-8 でエンコードし、最大サイズが 240 バイトである必要があります。 |
entityStatus |
必須。このキャンペーンの広告掲載オーダーで、予算を使用して広告枠に入札できるかどうかを指定します。
|
updateTime |
出力のみ。キャンペーンが最後に更新されたときのタイムスタンプ。システムによって割り当てられます。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
campaignGoal |
必須。キャンペーンの目標。 |
campaignFlight |
必須。キャンペーンの予定費用と期間。 |
frequencyCap |
必須。キャンペーンのフリークエンシー キャップ設定。 |
campaignBudgets[] |
このキャンペーンで使用できる予算のリストです。 このフィールドが設定されていない場合、キャンペーンでは無制限の予算が使用されます。 |
CampaignGoal
キャンペーンの目標を管理する設定です。
JSON 表現 |
---|
{ "campaignGoalType": enum ( |
フィールド | |
---|---|
campaignGoalType |
必須。キャンペーンの目標のタイプ。 |
performanceGoal |
必須。キャンペーンのパフォーマンス目標。
|
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 |
必須。掲載結果目標のタイプ。 |
共用体フィールド performance_goal_value 。必須。特定の performance_goal_type に対応するパフォーマンス目標値。performance_goal_value は次のいずれかになります。 |
|
performanceGoalAmountMicros |
目標額(広告主の通貨のマイクロ単位)。
たとえば、1500000 は 1.5 標準通貨を表します。 |
performanceGoalPercentageMicros |
目標の割合の小数表現(マイクロ単位)。
たとえば、70000 は 7%(10 進数 0.07)を表します。 |
performanceGoalString |
重要業績評価指標(KPI)の文字列。空でもかまいません。長さが 100 文字以下で、UTF-8 でエンコードされている必要があります。
|
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 ( |
フィールド | |
---|---|
plannedSpendAmountMicros |
特定の 金額はマイクロ単位で表示されます。0 以上の値を指定する必要があります。たとえば、500000000 は 500 標準通貨を表します。 |
plannedDates |
必須。キャンペーンの実施予定日。親広告主のタイムゾーンが基準となります。
|
CampaignBudget
キャンペーン予算の割り当て方法を管理する設定です。
JSON 表現 |
---|
{ "budgetId": string, "displayName": string, "budgetUnit": enum ( |
フィールド | |
---|---|
budgetId |
キャンペーン予算の一意の ID です。システムによって割り当てられます。新しい予算には設定しないでください。
|
displayName |
必須。予算の表示名。 UTF-8 でエンコードし、最大サイズが 240 バイトである必要があります。 |
budgetUnit |
必須。変更不可。予算の測定方法(通貨とインプレッション)を指定します。 |
budgetAmountMicros |
必須。リンクされている広告掲載オーダー セグメントで予算を設定できる合計額です。 金額はマイクロ単位で表示されます。0 より大きい値を指定してください。たとえば、500000000 は 500 標準通貨を表します。 |
dateRange |
必須。キャンペーン予算の期間。リンクした予算セグメントは期間が異なる可能性があります。親広告主のタイムゾーンが基準となります。
|
externalBudgetSource |
必須。予算の外部ソース。 |
externalBudgetId |
変更不可。外部ソースに対してこの予算を識別する ID。 このフィールドが設定され、対応する請求プロファイルの請求書の詳細レベルが「予算レベル PO」に設定されている場合、この予算に対して配信されるすべてのインプレッションに請求書にこの ID が含まれます。 キャンペーン内で一意である必要があります。 |
invoiceGroupingId |
変更不可。同じ請求書に含める予算をグループ化するために使用する ID。 このフィールドが設定され、対応する請求プロファイルの請求書レベルが「予算請求書グループ ID」に設定されている場合、同じ |
prismaConfig |
Mediaocean Prisma ツールで使用する追加のメタデータ。 Mediaocean 予算の場合は必須です。
|
ExternalBudgetSource
キャンペーン予算セグメントの外部ソース。
列挙型 | |
---|---|
EXTERNAL_BUDGET_SOURCE_UNSPECIFIED |
このバージョンでは外部予算ソースの値が指定されていないか、不明です。 |
EXTERNAL_BUDGET_SOURCE_NONE |
予算に外部ソースがありません。 |
EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN |
予算ソースは Mediaocean です。 |
PrismaConfig
Mediaocean Prisma ツールに固有の設定。
JSON 表現 |
---|
{ "prismaType": enum ( |
フィールド | |
---|---|
prismaType |
必須。Prisma のタイプ。 |
prismaCpeCode |
必須。Mediaocean Prisma ツールの関連するクライアント、プロダクト、見積もりコード。 |
supplier |
必須。エンティティがこの予算を割り当てた(DSP、サイトなど)。 |
PrismaType
Prisma 予算で使用可能なタイプ。
列挙型 | |
---|---|
PRISMA_TYPE_UNSPECIFIED |
このバージョンではタイプが指定されていないか、不明です。 |
PRISMA_TYPE_DISPLAY |
表示タイプ。 |
PRISMA_TYPE_SEARCH |
検索タイプ。 |
PRISMA_TYPE_VIDEO |
動画タイプ。 |
PRISMA_TYPE_AUDIO |
音声タイプ。 |
PRISMA_TYPE_SOCIAL |
ソーシャル タイプ。 |
PRISMA_TYPE_FEE |
料金のタイプ。 |
PrismaCpeCode
Google お支払いセンターでは、このコードのコンポーネント フィールドの検索とフィルタリングがサポートされています。
JSON 表現 |
---|
{ "prismaClientCode": string, "prismaProductCode": string, "prismaEstimateCode": string } |
フィールド | |
---|---|
prismaClientCode |
Prisma クライアント コード。 |
prismaProductCode |
Prisma の商品コード。 |
prismaEstimateCode |
Prisma の推定コード。 |
Methods |
|
---|---|
|
新しいキャンペーンを作成します。 |
|
キャンペーンを完全に削除します。 |
|
キャンペーンを取得します。 |
|
広告主のキャンペーンを一覧表示します。 |
|
複数のターゲティング タイプでキャンペーンに割り当てられているターゲティング オプションを一覧表示します。 |
|
既存のキャンペーンを更新します。 |