AdvertiserAccount データ オブジェクト - Customer Management
広告主アカウントを定義します。
構文
<xs:complexType name="AdvertiserAccount" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:sequence>
<xs:element minOccurs="0" name="BillToCustomerId" nillable="true" type="xs:long" />
<xs:element minOccurs="0" name="CurrencyCode" nillable="true" type="tns:CurrencyCode" />
<xs:element minOccurs="0" name="AccountFinancialStatus" nillable="true" type="tns:AccountFinancialStatus" />
<xs:element minOccurs="0" name="Id" nillable="true" type="xs:long" />
<xs:element minOccurs="0" name="Language" nillable="true" type="tns:LanguageType" />
<xs:element minOccurs="0" name="LastModifiedByUserId" nillable="true" type="xs:long" />
<xs:element minOccurs="0" name="LastModifiedTime" nillable="true" type="xs:dateTime" />
<xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Number" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ParentCustomerId" type="xs:long" />
<xs:element minOccurs="0" name="PaymentMethodId" nillable="true" type="xs:long" />
<xs:element minOccurs="0" name="PaymentMethodType" nillable="true" type="tns:PaymentMethodType" />
<xs:element minOccurs="0" name="PrimaryUserId" nillable="true" type="xs:long" />
<xs:element minOccurs="0" name="AccountLifeCycleStatus" nillable="true" type="tns:AccountLifeCycleStatus" />
<xs:element minOccurs="0" name="TimeStamp" nillable="true" type="xs:base64Binary" />
<xs:element minOccurs="0" name="TimeZone" nillable="true" type="tns:TimeZoneType" />
<xs:element minOccurs="0" name="PauseReason" nillable="true" type="xs:unsignedByte" />
<xs:element xmlns:q1="http://schemas.datacontract.org/2004/07/System.Collections.Generic" minOccurs="0" name="ForwardCompatibilityMap" nillable="true" type="q1:ArrayOfKeyValuePairOfstringstring" />
<xs:element minOccurs="0" name="LinkedAgencies" nillable="true" type="tns:ArrayOfCustomerInfo" />
<xs:element minOccurs="0" name="SalesHouseCustomerId" nillable="true" type="xs:long" />
<xs:element xmlns:q2="http://schemas.datacontract.org/2004/07/System.Collections.Generic" minOccurs="0" name="TaxInformation" nillable="true" type="q2:ArrayOfKeyValuePairOfstringstring" />
<xs:element minOccurs="0" name="BackUpPaymentInstrumentId" nillable="true" type="xs:long" />
<xs:element minOccurs="0" name="BillingThresholdAmount" nillable="true" type="xs:decimal" />
<xs:element minOccurs="0" name="BusinessAddress" nillable="true" type="tns:Address" />
<xs:element minOccurs="0" name="AutoTagType" nillable="true" type="tns:AutoTagType" />
<xs:element minOccurs="0" name="SoldToPaymentInstrumentId" nillable="true" type="xs:long" />
<xs:element minOccurs="0" name="TaxCertificate" nillable="true" type="tns:AccountTaxCertificate">
<xs:annotation>
<xs:appinfo>
<DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="AccountMode" nillable="true" type="xs:string">
<xs:annotation>
<xs:appinfo>
<DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
</xs:appinfo>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
要素
AdvertiserAccount オブジェクトには、AccountFinancialStatus、AccountLifeCycleStatus、AccountMode、AutoTagType、BackUpPaymentInstrumentId、BillingThresholdAmount、BillToCustomerId、BusinessAddress、CurrencyCode、ForwardCompatibilityMap、Id、Language、LastModifiedByUserId、LastModifiedTime、LinkedAgencies、Name、Number、ParentCustomerId、PauseReason、PaymentMethodId、PaymentMethodType、PrimaryUserId、SalesHouseCustomerId、soldToPaymentInstrumentId、TaxCertificate、TaxInformation、TimeStamp、TimeZone。
要素 | 説明 | データ型 |
---|---|---|
AccountFinancialStatus | アカウントの財務状態。 たとえば、状態は、アカウントが良好な状態にあるか、期限が過ぎているかを示すことができます。 足す: 読み取り専用 更新: 読み取り専用 |
AccountFinancialStatus |
AccountLifeCycleStatus | アカウントの状態。 アカウントの状態を設定することはできません。 足す: 読み取り専用 更新: 読み取り専用 |
AccountLifeCycleStatus |
AccountMode | アカウント モードでは、スマート アカウントとエキスパート アカウントが区別されます。 使用可能な値は次のとおりですが、これらに限定されません。 エキスパート - エキスパート モードは、フル機能の Microsoft Advertising エクスペリエンスです。 これにより、キャンペーン管理をより詳細に制御したり、広告にコンテンツを追加したり、パフォーマンスレポートやトラッキングの方法をより多く提供したりできます。 スマート - Microsoft 広告では、Microsoft AI を使用して広告を作成し、広告キャンペーンを管理します。 UnifiedSmart - アカウントは、Bing、Google、Facebook全体の広告をサポートします。 Facebook、Instagram、LinkedIn でソーシャル ネットワークのプレゼンスを管理することもできます。 注: 2023 年 4 月 25 日の時点で、UnifiedSmart は Twitter をサポートしなくなりました。 ほとんどのBing広告 API 操作は、エキスパート アカウントでのみサポートされます。 アカウント モードのアカウントは、アカウント情報 ( FindAccountsOrCustomersInfo、 GetAccount、 GetAccountsInfo、 GetUser、 SearchAccounts など) を要求すると返されます。 足す: ほとんどのアカウントの読み取り専用。 終了した統合スマート キャンペーン パイロットのお客様は、アカウント モードを "UnifiedSmart" に設定できます。 更新: 読み取り専用 |
string |
AutoTagType | サポートされている UTM 追跡コードを追加するか置き換えるかを決定します。 Microsoft Advertising では、ターゲット URL に UTM タグを自動的に追加できるため、Google Analytics などの Web サイト分析ツールを使用して、ユーザーが Web サイトにアクセスした方法を追跡できます。 自動タグは、拡張テキスト広告、キーワード、Microsoft ショッピング キャンペーン、サイトリンク拡張機能などに適用されます。 自動タグ付けの詳細については、ランディング ページ URL に UTM タグを追加操作方法 Microsoft Advertising のヘルプ記事を参照してください。 足す: 随意。 指定しない場合、既定値は非アクティブです。 更新: 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。 |
AutoTagType |
BackUpPaymentInstrumentId | アカウントの決済に使用するバックアップ支払手段の識別子。 この要素は、請求先のアカウントには適用されません。 足す: 読み取り専用 更新: 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。 |
long |
BillingThresholdAmount | 選択した支払方法に対する決済に対して顧客が指定した金額。 足す: 読み取り専用 更新: 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。 |
小数 |
BillToCustomerId | アカウントが生成する料金に対して課金される顧客の識別子。 これは、所有者の代わりにこのアカウントを管理するアグリゲーターか、アカウントを所有する顧客の識別子です。 サービスは、 PaymentMethodId 要素で識別される支払い方法の所有者に基づいて識別子を設定します。 足す: 読み取り専用 更新: 読み取り専用 |
long |
BusinessAddress | ビジネスが法的に登録されている場所。 顧客のエージェントとして働く代理店の場合、これはクライアントが法的に登録されている場所です。 アグリゲーターとして働く代理店の場合、これは会社の法的に登録されたビジネス アドレスです。 ビジネス アドレスは、税要件を決定するために使用されます。 足す: 必須。 Address BusinessName、City、Line1 の各要素は、すべての国または地域で必要です。 ブラジル (BR) とインド (IN) の場合、PostalCode 要素と StateOrProvince 要素も必要です。 更新: 月次請求書で課金されないアカウントの場合は省略可能です。 つまり、 Address に変更を加える場合は、BusinessName、City、CountryCode、Line1、StateOrProvince 要素 (該当する場合) を設定する必要があります。月次請求書アカウントの読み取り専用。 請求書アカウントの BusinessAddress を更新するには、アカウント マネージャーまたはサポートにお問い合わせください。 |
Address |
CurrencyCode | 勘定決済に使用される通貨の ISO コード。 サービスは、課金目的で通貨情報を使用します。 足す: 必須 更新: 読み取り専用 |
CurrencyCode |
ForwardCompatibilityMap | 現在の API バージョンで新しい要素が追加されたときに変更が中断されないように、前方互換性のためのキー文字列と値文字列の一覧。 今後のリリースでは、今後の互換性の変更に関するページを参照してください。 現在、このオブジェクトの前方互換性の変更はありません。 |
KeyValuePairOfstring 配列 |
身分証明書 | アカウントのシステム生成識別子。 これは、多くのキャンペーン要求で AccountId 要素と CustomerAccountId SOAP ヘッダーを に設定した識別子です。 足す: 読み取り専用 更新: 必須 |
long |
言語 | Microsoft Advertising から受け取った課金ドキュメントのレンダリングに使用する言語 (支払い方法として請求書を使用する場合)。 この設定は、このアカウントの課金ドキュメント専用であり、他の Microsoft Advertising アカウントには適用されません。 顧客のサインアップ時にこの値を空のままにした場合、操作ではプライマリ ユーザーの Lcid 要素の言語値が使用されます。 Lcid が FrenchCanada などの値に設定されている場合、アカウント言語はフランス語に設定されます。 足す:AddAccount の読み取り専用。UserInvitation が設定されている場合は SignupCustomer に必要です。それ以外の場合、この要素は省略可能です。 更新: 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。 |
LanguageType |
LastModifiedByUserId | アカウントの情報を更新する最後のユーザーの識別子。 足す: 読み取り専用 更新: 読み取り専用 |
long |
LastModifiedTime | アカウントが最後に更新された日付と時刻。 値は、世界協定時刻 (UTC) です。 日付と時刻の値は、クライアントではなく、サーバーでの日付と時刻を反映します。 日付と時刻の形式については、「 プリミティブ XML データ型」の dateTime エントリを参照してください。 足す: 読み取り専用 更新: 読み取り専用 |
dateTime |
LinkedAgencies | このアカウントにリンクされている機関の一覧。 現在、アカウントを追加する際にサポートされている代理店の顧客は 1 つだけです。 アカウントを取得すると、リンクされているすべての代理店の顧客情報が含まれます。 足す:AddAccount の場合は省略可能です。代理顧客がクライアントの代理でアカウントを作成するパイロット (GetCustomerPilotFeatures から 793 が返される) にある場合は、SignupCustomer の省略可能です。 アグリゲーターは、このコンテキストでエージェンシーとしてリンクできないため、この要素を設定できません。 更新: 読み取り専用 |
CustomerInfo 配列 |
名前 | アカウントの名前。 文字列には 3 ~ 100 文字を含めることができます。顧客内のすべてのアカウント名の中で一意である必要があります。 足す: 必須 更新: 必須 |
string |
数値 | Microsoft Advertising Web アプリケーションのアカウントを識別するために使用されるシステム生成のアカウント番号。 アカウント番号は xxxxxxxx という形式で、 xxxxxxxx は 8 文字の英数字の系列です。 足す: 読み取り専用 更新: 読み取り専用 |
string |
ParentCustomerId | アカウントを所有する顧客の識別子。 顧客識別子を必要とするキャンペーン要求では、これは CustomerId SOAP ヘッダーを に設定した識別子です。 足す:AddAccount に必要です。UserInvitation が設定されていない場合は SignupCustomer に必要です。それ以外の場合、この要素は無視されます。 更新: 読み取り専用 |
long |
PauseReason | アカウントを一時停止したユーザーを示すフラグ値。 指定可能な値は次のいずれかです。 1 - ユーザーがアカウントを一時停止しました。 2 - 課金サービスがアカウントを一時停止しました。 4 - ユーザーと課金サービスがアカウントを一時停止しました。 足す: 読み取り専用 更新: 読み取り専用 |
unsignedByte |
PaymentMethodId | アカウントの決済に使用する支払い方法の識別子。 足す:AddAccount の場合は省略可能です。UserInvitation が設定されていない場合は、SignupCustomer の読み取り専用です。 SignupCustomer を呼び出すときに、この要素を NULL に設定します。 サービスは、アグリゲーターの顧客の請求書に関連付けられている支払い方法識別子を自動的に取得します。 [SignupCustomer] の場合は、UserInvitation が設定され、新しいクライアント アカウントが LinkedAgencies 経由で代理店にリンクされている場合、および代理店に請求する必要がある場合は、この要素を代理店の支払い方法 ID に設定します。 それ以外の場合は、この要素を null のままにする必要があります。 更新: 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。 |
long |
PaymentMethodType | 口座決済に使用する支払方法の種類。 この値は、 PaymentMethodId 要素に対応する支払手段によって決定されるため、この値を設定する必要はありません。 GetAccount と SearchAccounts を呼び出してアカウント データを取得すると、PaymentMethodType は NULL に設定され、アカウントが使用する支払い方法を決定することはできません。 内部使用のため予約済みです。 足す: 読み取り専用 更新: 読み取り専用 |
PaymentMethodType |
PrimaryUserId | このアカウントの管理を主に担当するアカウント マネージャーの識別子。 アカウントのプライマリ連絡先として設定できるのは、スーパー 管理 ユーザーとStandard ユーザーのみです。 足す:新しいクライアント アカウントが LinkedAgencies 経由で機関にリンクされている場合は、AddAccount の場合は、新しいアカウントのプライマリ ユーザーとしていずれかの機関ユーザーを割り当てることができます。 UserInvitation を含めずにアグリゲーターとして SignupCustomer を呼び出す場合は、この要素を空のままにし、プライマリ ユーザーがアグリゲーター ユーザー識別子に設定されます。 SignupCustomer を呼び出し、UserInvitation が含まれている場合、この要素を空のままにすると、プライマリ ユーザーは招待を受け入れる新しいクライアント ユーザーの識別子に設定されます。 SignupCustomer を呼び出し、UserInvitation が設定されている場合、および新しいクライアント アカウントが LinkedAgencies を介して機関にリンクされている場合は、いずれかの機関ユーザーを新しいアカウントのプライマリ ユーザーとして割り当てることができます。 更新: 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。 |
long |
SalesHouseCustomerId | セールス リードを担当するサード パーティの識別子。 足す: 読み取り専用 更新: 読み取り専用 |
long |
SoldToPaymentInstrumentId | アカウントの決済に使用するクライアント (販売先顧客) の支払い方法の識別子。 足す:BillToCustomerId が ParentCustomerId と異なる場合は、AddAccount に必要です。読み取り専用で、SignupCustomer には適用されません。 更新: 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。 |
long |
TaxCertificate | アカウント税証明書のデータ オブジェクト。 | AccountTaxCertificate |
TaxInformation | この要素の有効なキーと値の文字列の一覧については、以下のセクションの 「AdvertiserAccount TaxInformation 」を参照してください。 足す: 随意 更新: 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。 キーと値のペアを削除するには、キーを設定し、値を空の文字列 ("") に設定します。 |
KeyValuePairOfstring 配列 |
タイムスタンプ |
UpdateAccount 操作と DeleteAccount 操作を呼び出すときに、システムが内部的に更新プログラムを調整するために使用するタイム スタンプ値。 足す: 読み取り専用 更新: 必須 |
base64Binary |
TimeZone | このアカウントのキャンペーンに使用する既定のタイム ゾーン値。 アカウントの追加時に値を指定しない場合、タイム ゾーンは既定で PacificTimeUSCanadaTijuana に設定されます。 このタイム ゾーンの値は、Microsoft Advertising Web アプリケーションによってアカウントのタイム ゾーン設定を表示するために使用され、一括またはキャンペーン管理 API を使用して作成されたキャンペーンの既定のタイム ゾーン値は提供されません。 足す: 随意 更新: 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。 |
TimeZoneType |
解説
AdvertiserAccount TaxInformation
以下は、AdvertiserAccount の TaxInformation 要素で使用できるキーの一覧です。
注:
Microsoft Advertising では、税金または VAT に関するガイダンスを提供できません。 ご不明な点がある場合は、税務顧問または地方税務署にお問い合わせください。
TaxInformation Key | 説明 | 国または地域 |
---|---|---|
AUGSTNumber | オーストラリアのアカウントの税識別子。 税識別子がないと、 BusinessAddress の場所に基づいて税金が適用される場合があります。 足す: 必須 更新: 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。 |
オーストラリア |
CCM | 法人の市区町村登録番号、または Cadastro de contribuinte mobiliario (CCM)。 足す: 随意 更新: 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。 |
ブラジル |
CNPJ | ブラジルのビジネス アカウントの税識別子。 税識別子がないと、 BusinessAddress の場所に基づいて税金が適用される場合があります。 足す: 必須 更新: 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。 |
ブラジル |
CPF | ブラジルの個人アカウントの税識別子。 税識別子がないと、 BusinessAddress の場所に基づいて税金が適用される場合があります。 足す: 必須 更新: 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。 |
ブラジル |
GSTINNumber | この ID は、ビジネスが登録されている状態コードを表す 2 つの番号から始まり、その後に最大 13 個の数字と文字が続きます。 足す: 随意 更新: 随意 |
インド |
GSTNumber | シンガポールでは、課金はアイルランドの Microsoft Ireland Operations Ltd.によって管理されます。 2020 年 1 月 1 日より、Microsoft Advertising はシンガポールに登録されている企業に対してシンガポール物品サービス税 (SG GST) を請求する必要があります。 SG GST 登録番号を指定した場合、Microsoft Advertising は SG GST を 0% で適用します。 SG GST 登録番号を指定しない場合、Microsoft Advertising は 7% SG GST を請求する必要があります。 (注: 税率は変更される場合があります。 使用可能な GSTNumber 形式には、2 つの英数字、省略可能なダッシュ、7 桁の数字、オプションのダッシュ、1 つの英数字が続きます。OR 8 桁または 9 桁の数字の後に 1 つの英数字が続きます。OR T または S の後に 2 桁の数字が続き、その後に 1 つの大文字の A から Z が続き、続いて 1 つの英数字、4 桁の後に 1 つの英数字が続きます。 GSTNumber の例: ab-1234567-a;ab1234567-a;ab1234567a;ab-1234567a;12345678a;123456789a;T12Aa1234a 足す: 随意 更新: 随意 |
シンガポール |
IsIVAOrVATTaxPayer | 値は TRUE または FALSE で、税の決定に使用されます。 足す: 必須 更新: 必須 |
チリ |
IsWithholdingTaxExempted | 値は TRUE または FALSE で、税の決定に使用されます。 足す: 必須 更新: 必須 |
チリ |
NZGSTNumber | これは 8 桁または 9 桁の長い税 ID です。 NZGSTNumber 税が適用されない場合は、ビジネスの場所に基づいて適用される場合があります。 足す: 随意 更新: 読み取り専用 |
ニュージーランド |
PanNumber | PAN 番号。 足す: 必須 更新: 読み取り専用 |
インド |
VATNumber | アカウントの付加価値税 (VAT) 登録番号 (VAT 識別子とも呼ばれます)。 VAT 番号は、 BusinessAddress 要素で指定した国または地域で有効である必要があります。 VAT 登録番号または免除証明書がないと、勤務先に基づいて税金が適用される場合があります。 足す: 随意 更新: 随意 |
詳細については、 国/地域ごとの VAT 番号の形式 に関するページを参照してください。 |
国または地域ごとの VAT 番号の形式
次の表に、国または地域ごとの VAT 登録番号の形式を示します。
VAT 番号 | 国/地域 |
---|---|
各国/地域に固有の 2 文字で始まり、その後に最大 12 桁の数字または文字が続きます。 | オーストリア、ベルギー、ブルガリア、キプロス、チェコ共和国、ドイツ、デンマーク、エストニア、ギリシャ、フィンランド、フランス、英国、クロアチア、ハンガリー、アイルランド、イタリア、リトアニア、ルクセンブルク、ラトビア、マルタ、モナコ、オランダ、ポーランド、ポルトガル、ルーマニア、スウェーデン、スロベニア、スロバキア。 |
XXXXXXXX-X または XXXXXXXX-K の形式である必要があります。X は 8 桁の数字の後に末尾の数字を表します。 | チリ |
HUXXXXXXXX (HU の後に 8 桁の数字が続く) の形式にする必要があります。 | ハンガリー |
LIXXXXX または XXXXX (両方の形式がサポートされ、LI は省略可能で、桁数は 5) である必要があります。 | リヒテンシュタイン |
XXXXXXXX-0001 (8 桁の数字が -0001 より前の形式) である必要があります。 | ナイジェリア |
PTXXXXXXXXX (PT の後に 9 桁) の形式を指定する必要があります。 | ポルトガル |
長さが 9 桁または 13 桁で、そのうち最初の 8 桁または 12 桁が実際の ID 番号で、最後の数字は ISO 7064 に従って計算されたチェックサム数字です(MOD 11 から 10)。 | セルビア |
CHE + 9 桁の数字 + TVA、MWST、または IVA (例: CHE-123.456.788 TVA)。 最後の数字は、重み付けパターンで構築された MOD11 チェックサムの数字です。5,4,3,2,7,6,5,4。 | スイス |
長さは 13 桁である必要があります。 | タイ |
要件
サービス: CustomerManagementService.svc v13
Namespace: https://bingads.microsoft.com/Customer/v13/Entities
使用ページ
AddAccount
GetAccount
SearchAccounts
SignupCustomer
UpdateAccount