REST Resource: advertisers

リソース: Advertiser

ディスプレイ＆ビデオ 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,
  "billingConfig": {
    object (AdvertiserBillingConfig)
  }
}
フィールド
name

string

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

string (int64 format)

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

string (int64 format)

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

string

必須。広告主の表示名。

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

enum (EntityStatus)

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

  • 指定できる値は ENTITY_STATUS_ACTIVE、ENTITY_STATUS_PAUSED、ENTITY_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 に送信することを承認します。
billingConfig

object (AdvertiserBillingConfig)

必須。広告主の請求関連の設定。

AdvertiserGeneralConfig

広告主の一般設定。

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

string

必須。広告主様のメインのウェブサイトのドメイン URL。この情報は、キャンペーンを広告主に関連付けるためにウェブサイトの 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 をご覧ください。

キャンペーン マネージャー 360 ハイブリッド広告主の場合、タイムゾーンは関連付けられているキャンペーン マネージャー 360 アカウントのタイムゾーンと同じです。サードパーティのみを使用する広告主の場合、タイムゾーンは親パートナーのタイムゾーンと同じです。
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,
  "cmAdvertiserIds": [
    string
  ],
  "cmSyncableSiteIds": [
    string
  ],
  "dv360ToCmDataSharingEnabled": boolean,
  "dv360ToCmCostReportingEnabled": boolean,
  "cmFloodlightLinkingAuthorized": boolean
}
フィールド
cmAccountId

string (int64 format)

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

string (int64 format)

必須。変更不可。ディスプレイ＆ビデオ 360 の広告主にリンクされているキャンペーン マネージャー 360 の Floodlight 設定の ID。
cmAdvertiserIds[]

string (int64 format)

出力専用。キャンペーン マネージャー 360 の Floodlight 設定を共有する CM360 広告主 ID のセット。
cmSyncableSiteIds[]

string (int64 format)

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

advertisers.create メソッドに指定されていないか空の場合、CM360 サイトが自動的に作成されます。

このリストからサイトを削除すると、キャンペーン マネージャー 360 からディスプレイ＆ビデオ 360 に同期されたクリエイティブが削除される可能性があります。少なくとも 1 つのサイトを指定する必要があります。
dv360ToCmDataSharingEnabled

boolean

キャンペーン マネージャー 360 のデータ転送レポートにディスプレイ＆ビデオ 360 のデータを追加するかどうか。
dv360ToCmCostReportingEnabled

boolean

ディスプレイ＆ビデオ 360 の費用をキャンペーン マネージャー 360 に報告するかどうか。
cmFloodlightLinkingAuthorized

boolean

必須。変更不可。このフィールドを true に設定すると、指定した Floodlight 設定からこのディスプレイ＆ビデオ 360 広告主への情報の共有を、会社を代表して承認します。

AdvertiserCreativeConfig

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

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

string (int64 format)

Integral Ad Service（IAS）が提供するキャンペーン モニタリングを設定するための ID。ディスプレイ＆ビデオ 360 のシステムは、この ID を含む IAS の「キャンペーン モニター」タグをクリエイティブ タグに追加します。
obaComplianceDisabled

boolean

オンライン行動ターゲティング広告（OBA）と規制要件に基づき、Google の「この広告について」機能を無効にするかどうか。この機能は、コンテンツを広告として示すバッジと、透明性に関する情報（「この広告について」で操作）を広告に追加します。「この広告について」を使用すると、表示される広告をユーザーが細かく管理でき、広告が表示される理由をわかりやすく伝えることができます。詳細

このフィールドを true に設定する場合は、ディスプレイ＆ビデオ 360 で配信される広告は次の要件を満たす必要があります。

  • Google マーケティング プラットフォームとの契約に定めるとおり、オンライン行動ターゲティング広告（OBA）に準拠している。
  • 欧州経済領域（EEA）では、透明性に関する情報と、ユーザーが違法なコンテンツを報告するメカニズムを広告に含める必要があります。広告のバッジ、透明性、レポートの代替ソリューションを使用している場合は、必要な透明性情報と違法なコンテンツの報告メカニズムが含まれていることを確認してください。また、違法なコンテンツの報告があった場合は、適切なフォームを使用して Google に通知する必要があります。
dynamicCreativeEnabled

boolean

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

boolean

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

広告主が 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

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

AdvertiserBillingConfig

広告主の請求関連の設定。

JSON 表現 
{
  "billingProfileId": string
}
フィールド
billingProfileId

string (int64 format)

必須。広告主に割り当てられた請求プロファイルの ID。

メソッド

audit

 広告主を監査します。

create

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

delete

 広告主を削除します。

editAssignedTargetingOptions

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

get

 広告主を取得します。

list

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

listAssignedTargetingOptions

 ターゲティング タイプにわたって広告主に割り当てられたターゲティング オプションを一覧表示します。

patch

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