REST Resource: advertisers

リソース: Advertiser

ディスプレイ &ビデオ 360 の 1 つの広告主動画 360(DV360)。

JSON 表現
{
  "name": string,
  "advertiserId": string,
  "partnerId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "generalConfig": {
    object (AdvertiserGeneralConfig)
  },
  "adServerConfig": {
    object (AdvertiserAdServerConfig)
  },
  "creativeConfig": {
    object (AdvertiserCreativeConfig)
  },
  "dataAccessConfig": {
    object (AdvertiserDataAccessConfig)
  },
  "integrationDetails": {
    object (IntegrationDetails)
  },
  "servingConfig": {
    object (AdvertiserTargetingConfig)
  },
  "prismaEnabled": boolean
}
フィールド
name

string

出力専用。広告主のリソース名。

advertiserId

string (int64 format)

出力専用。広告主の一意の ID。システムによって割り当てられます。

partnerId

string (int64 format)

必須。変更不可。広告主が属するパートナーの一意の ID。

displayName

string

必須。広告主の表示名。

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

entityStatus

enum (EntityStatus)

必須。広告主の広告掲載オーダーと広告申込情報が予算を消化して広告枠に入札できるかどうかを制御します。

  • 指定できる値は ENTITY_STATUS_ACTIVEENTITY_STATUS_PAUSEDENTITY_STATUS_SCHEDULED_FOR_DELETION です。
  • ENTITY_STATUS_SCHEDULED_FOR_DELETION に設定した場合、広告主は最初に削除予定から 30 日後に削除されます。
updateTime

string (Timestamp format)

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

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

generalConfig

object (AdvertiserGeneralConfig)

必須。広告主の全般設定。

adServerConfig

object (AdvertiserAdServerConfig)

必須。変更不可。広告主の広告サーバー関連の設定。

creativeConfig

object (AdvertiserCreativeConfig)

必須。広告主のクリエイティブ関連の設定。

dataAccessConfig

object (AdvertiserDataAccessConfig)

広告主のデータへのアクセス方法を管理する設定です。

integrationDetails

object (IntegrationDetails)

広告主の統合の詳細。現在、広告主に適用できるのは integrationCode のみです。IntegrationDetails の他のフィールドはサポートされていないため、指定した場合は無視されます。

servingConfig

object (AdvertiserTargetingConfig)

広告主の広告配信に関連するターゲット設定です。

prismaEnabled

boolean

Mediaocean(Prisma)との統合を有効にするかどうか。これを有効にすると、以下に同意したことになります。

私は会社を代表して、Mediaocean(Prisma)が予算セグメントプランを Google に送信することを承認します。また、この広告主の予算計画、請求、調整を行う目的で、Google がディスプレイ&ビデオ 360 から対応するレポートと請求書を Mediaocean に送信することを承認します。

AdvertiserGeneralConfig

広告主の全般設定。

JSON 表現
{
  "domainUrl": string,
  "timeZone": string,
  "currencyCode": string
}
フィールド
domainUrl

string

必須。広告主のプライマリ ウェブサイトのドメイン URL。この情報は、キャンペーンを広告主に関連付けるためにウェブサイトの URL を必要とするパブリッシャーに送られます。

http: または https: で始まる URL には、パスやクエリ文字列を含めないでください。たとえば、http://www.example.com のように指定します。

timeZone

string

出力専用。広告主のタイムゾーンの標準 TZ データベース名。たとえば、America/New_York です。

詳しくは、https://en.wikipedia.org/wiki/List_of_tz_database_time_zones をご覧ください。

CM360 と混合型の広告主様の場合、タイムゾーンは関連する CM360 アカウントのタイムゾーンと同じになります。第三者のみの広告主の場合、タイムゾーンは親パートナーのタイムゾーンと同じになります。

currencyCode

string

必須。変更不可。広告主の通貨(ISO 4217 形式)。

使用できるコードとそれらの通貨は次のとおりです。

通貨コード : 通貨名

  • ARS : アルゼンチン ペソ
  • AUD : オーストラリア ドル
  • BRL : ブラジル レアル
  • CAD : カナダドル
  • CHF : スイス フラン
  • CLP : チリ ペソ
  • CNY : 中国元
  • COP : コロンビア ペソ
  • CZK : チェコ コルナ
  • DKK : デンマーク クローネ
  • EGP : エジプション ポンド
  • EUR : ユーロ
  • GBP : イギリス ポンド
  • HKD : 香港ドル
  • HUF : フォリント(ハンガリー)
  • IDR : インドネシア ルピア
  • ILS : イスラエル シケル
  • INR : インドルピー
  • JPY : 日本円
  • KRW : 韓国ウォン
  • MXN : メキシコ ペソ
  • MYR : リンギット(マレーシア)
  • NGN : ナイジェリア ナイラ
  • NOK : ノルウェー クローネ
  • NZD : ニュージーランド ドル
  • PEN : ペルー ヌエボソル
  • PLN : ポーランド ズウォティ
  • RON : 新ルーマニア レイ
  • RUB : ロシア ルーブル
  • SEK : スウェーデン クローナ
  • TRY : トルコ リラ
  • TWD : 台湾ドル
  • USD : 米ドル
  • ZAR : 南アフリカ ランド

AdvertiserAdServerConfig

広告主の広告サーバー関連の設定。

JSON 表現
{

  // Union field ad_server_config_scheme can be only one of the following:
  "thirdPartyOnlyConfig": {
    object (ThirdPartyOnlyConfig)
  },
  "cmHybridConfig": {
    object (CmHybridConfig)
  }
  // End of list of possible types for union field ad_server_config_scheme.
}
フィールド
共用体フィールド ad_server_config_scheme。必須。ad_server_config_scheme は次のいずれかになります。
thirdPartyOnlyConfig

object (ThirdPartyOnlyConfig)

第三者広告サーバーのみを使用する広告主向けの設定です。

cmHybridConfig

object (CmHybridConfig)

キャンペーン マネージャー 360(CM360)と第三者広告サーバーの両方を使用する広告主向けの設定です。

ThirdPartyOnlyConfig

第三者広告サーバーのみを使用する広告主向けの設定。

JSON 表現
{
  "pixelOrderIdReportingEnabled": boolean
}
フィールド
pixelOrderIdReportingEnabled

boolean

ピクセルのオーダー ID レポートが有効かどうか。この値は、true に設定すると変更できません。

CmHybridConfig

キャンペーン マネージャー 360(CM360)と第三者広告サーバーの両方を使用する広告主向けの設定。

JSON 表現
{
  "cmAccountId": string,
  "cmFloodlightConfigId": string,
  "cmSyncableSiteIds": [
    string
  ],
  "dv360ToCmDataSharingEnabled": boolean,
  "dv360ToCmCostReportingEnabled": boolean,
  "cmFloodlightLinkingAuthorized": boolean
}
フィールド
cmAccountId

string (int64 format)

必須。変更不可。ディスプレイ&ビデオ 360 広告主にリンクされている CM360 Floodlight 設定のアカウント ID。

cmFloodlightConfigId

string (int64 format)

必須。変更不可。ディスプレイ&ビデオ 360 広告主にリンクされている CM360 Floodlight 設定の ID。

cmSyncableSiteIds[]

string (int64 format)

プレースメントがクリエイティブとしてディスプレイ&ビデオ 360 に同期される CM360 サイトのリスト。

advertisers.create メソッドに存在しない場合や空の場合は、CM360 サイトが自動的に作成されます。

このリストからサイトを削除すると、CM360 から同期されたディスプレイ&ビデオ 360 クリエイティブが削除される可能性があります。少なくとも 1 つのサイトを指定する必要があります。

dv360ToCmDataSharingEnabled

boolean

CM360 のデータ転送レポートにディスプレイ&ビデオ 360 のデータを含めるかどうか。

dv360ToCmCostReportingEnabled

boolean

ディスプレイ&ビデオ 360 の費用を CM360 に報告するかどうか。

cmFloodlightLinkingAuthorized

boolean

必須。変更不可。このフィールドを true に設定すると、指定した Floodlight 設定の情報がこのディスプレイ &ビデオ 360 と共有されるということを、会社を代表して承認したことになります。動画 360 の広告主。

AdvertiserCreativeConfig

広告主のクリエイティブ関連の設定。

JSON 表現
{
  "iasClientId": string,
  "obaComplianceDisabled": boolean,
  "dynamicCreativeEnabled": boolean,
  "videoCreativeDataSharingAuthorized": boolean
}
フィールド
iasClientId

string (int64 format)

Integral Ad Service(IAS)が提供するキャンペーン モニタリングを設定するための ID。ディスプレイ&ビデオ 360 システムでは、IAS の「キャンペーン モニター」が追加されます。追加する必要があります。

obaComplianceDisabled

boolean

ディスプレイ&ビデオ 360 のオンライン行動ターゲティング広告(OBA)コンプライアンスを使用するかどうか。

警告: OBA の設定を変更すると、一部のアド エクスチェンジでクリエイティブの監査ステータスがリセットされ、再度承認されるまで配信できなくなる場合があります。

dynamicCreativeEnabled

boolean

広告主がダイナミック クリエイティブに対して有効になっているかどうか。

videoCreativeDataSharingAuthorized

boolean

このフィールドを true に設定すると、貴社を代表して、このディスプレイ &ビデオ 360 に関連付けられた動画クリエイティブの使用を Google に許可したことになります動画 360 の広告主は、広告主のテレビ キャンペーンに関連するレポートと機能を提供します。

広告主が CM360 hybrid 広告サーバー設定を使用している場合にのみ適用されます。

AdvertiserDataAccessConfig

広告主関連データへのアクセス方法を管理する設定です。

JSON 表現
{
  "sdfConfig": {
    object (AdvertiserSdfConfig)
  }
}
フィールド
sdfConfig

object (AdvertiserSdfConfig)

広告主様の構造化データファイル(SDF)の設定。

指定しない場合、親パートナーの SDF 設定が使用されます。

AdvertiserSdfConfig

広告主の構造化データファイル(SDF)の設定。

JSON 表現
{
  "overridePartnerSdfConfig": boolean,
  "sdfConfig": {
    object (SdfConfig)
  }
}
フィールド
overridePartnerSdfConfig

boolean

この広告主が親パートナーの SDF 設定をオーバーライドするかどうか。

デフォルトでは、広告主は親パートナーから SDF の設定を継承します。パートナーの設定をオーバーライドするには、このフィールドを true に設定し、sdfConfig で新しい設定を指定します。

sdfConfig

object (SdfConfig)

広告主の SDF 設定。

AdvertiserTargetingConfig

広告主の広告配信に関連するターゲット設定です。

JSON 表現
{
  "exemptTvFromViewabilityTargeting": boolean
}
フィールド
exemptTvFromViewabilityTargeting

boolean

広告主に属するすべての動画広告申込情報で、コネクテッド テレビ デバイスが視認性ターゲティングから除外されるかどうか。

メソッド

audit

広告主を監査します。

bulkEditAdvertiserAssignedTargetingOptions

1 つの広告主のターゲティング オプションを一括編集する。

bulkListAdvertiserAssignedTargetingOptions

さまざまなターゲティング タイプで広告主に割り当てられているターゲティング オプションを一覧表示します。

create

新しい広告主を作成します。

delete

広告主を削除します。

get

広告主を取得します。

list

現在のユーザーがアクセスできる広告主を一覧表示します。

patch

既存の広告主を更新します。