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)
  },
  "containsEuPoliticalAds": enum (EuPoliticalAdvertisingStatus)
}
フィールド
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)

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

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
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)

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

enum (EuPoliticalAdvertisingStatus)

省略可。この広告主様に欧州連合の政治広告を配信する広告申込情報が含まれているかどうか。

このフィールドが DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING に設定されている場合、次のようになります。

  • この広告主の下に作成された新しい広告申込情報は、特に指定がない限り DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING が割り当てられます。
  • この広告主の既存の広告申込情報で値が設定されていないものは、1 日以内に DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING に更新されます。

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,
  "cmAdvertiserIds": [
    string
  ],
  "cmSyncableSiteIds": [
    string
  ],
  "dv360ToCmDataSharingEnabled": boolean,
  "dv360ToCmCostReportingEnabled": boolean,
  "cmFloodlightLinkingAuthorized": boolean
}
フィールド
cmAccountId

string (int64 format)

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

string (int64 format)

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

string (int64 format)

出力専用。CM360 Floodlight 設定を共有する CM360 広告主 ID のセット。
cmSyncableSiteIds[]

string (int64 format)

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

advertisers.create メソッドで指定されていない場合や空の場合、システムはキャンペーン マネージャー 360 のサイトを自動的に作成します。

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

boolean

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

boolean

ディスプレイ＆ビデオ 360 の費用を CM360 にレポートするかどうか。
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

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

get

 広告主を取得します。

list

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

listAssignedTargetingOptions

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

patch

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