SitelinkAdExtension データ オブジェクト - キャンペーン管理

  • [アーティクル]

広告拡張機能ごとに 1 つのサイトリンクを持つオブジェクトを定義します。 サイトリンクを使用して、Web サイトの特定の製品、サービス、またはセクションを宣伝し、潜在的な顧客が検索していた情報を正確に取得できます。 これにより、クリックスルー率とコンバージョンの両方が増加する可能性があります。

サイトリンク広告拡張機能をアカウントに関連付けるか、アカウント内のキャンペーンや広告グループに関連付けることができます。 各エンティティ (アカウント、キャンペーン、または広告グループ) は、最大 20 個のサイトリンク広告表示オプションに関連付けることができます。

構文

<xs:complexType name="SitelinkAdExtension" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:AdExtension">
      <xs:sequence>
        <xs:element minOccurs="0" name="Description1" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="Description2" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="DestinationUrl" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="DisplayText" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="FinalAppUrls" nillable="true" type="tns:ArrayOfAppUrl" />
        <xs:element xmlns:q49="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalMobileUrls" nillable="true" type="q49:ArrayOfstring" />
        <xs:element minOccurs="0" name="FinalUrlSuffix" nillable="true" type="xs:string" />
        <xs:element xmlns:q50="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalUrls" nillable="true" type="q50:ArrayOfstring" />
        <xs:element minOccurs="0" name="TrackingUrlTemplate" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="UrlCustomParameters" nillable="true" type="tns:CustomParameters" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

要素

SitelinkAdExtension オブジェクトには、Description1、Description2、DestinationUrl、DisplayText、FinalAppUrls、FinalMobileUrls、FinalUrls、FinalUrlSuffix、TrackingUrlTemplate、UrlCustomParameters という要素があります。

要素 説明 データ型
Description1 サイト リンクの説明 1 行目。

最大入力長は 35 文字です。 繁体字中国語が含まれている場合、制限は 15 文字です。 繁体字中国語の各文字は 2 文字としてカウントされ、各英語文字は 1 文字としてのみカウントされます。

Description1 を指定する場合は、Description2 が必要です。

足す： 随意
更新： 随意。 更新プログラムに値が設定されていない場合、以前の設定は削除されます。		 string
Description2 サイト リンクの説明 2 行目。

最大入力長は 35 文字です。 繁体字中国語が含まれている場合、制限は 15 文字です。 繁体字中国語の各文字は 2 文字としてカウントされ、各英語文字は 1 文字としてのみカウントされます。

Description2 を指定する場合は、Description1 が必要です。

足す： 随意
更新： 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。 この要素を空の文字列 ("") に設定すると、前の設定が削除されます。		 string
DestinationUrl ユーザーがサイト リンクをクリックしたときに取得される Web ページの URL。

大事な： 現在宛先 URL を使用している場合は、最終的な URL に置き換える必要があります。 詳細については、「 アップグレードされた URL を使用した URL 追跡」を参照してください。

URL には、{MatchType} などの動的パラメーターを含めることができます。 サポートされているパラメーターの一覧については、Microsoft Advertising のヘルプ記事「 どのような追跡パラメーターまたは URL パラメーターを使用できますか?」を参照してください。

URL には、最大 1,024 文字を含めることができます。 URL でプロトコルが指定されていない場合、ユーザーが広告をクリックすると、システムは HTTP プロトコルを使用します。 広告を追加するときに URL で HTTP プロトコルが指定されている場合、サービスは http:// プロトコル文字列を削除します (HTTP プロトコル文字列は 1,024 文字の制限に対してカウントされません)。ただし、サービスは URL から HTTPS プロトコル文字列 (https://) を削除しません。

足す： 禁じられた。 宛先 URL は非推奨であり、代わりに FinalUrls 要素を設定する必要があります。
更新： 随意。 宛先 URL は非推奨であり、代わりに FinalUrls 要素を設定する必要があります。 この要素は空のままにするか、空の文字列に設定できます。		 string
DisplayText 広告に表示されるサイトリンクテキスト。

Description1 または Description2 を指定した場合、表示テキストには最大 25 文字を含めることができます。それ以外の場合、表示テキストには最大 35 文字を含めることができます。 繁体字中国語が含まれている場合、制限は Description1 または Description2 に指定された 11 文字、それ以外の場合は 15 文字です。 繁体字中国語の各文字は 2 文字としてカウントされ、各英語文字は 1 文字としてのみカウントされます。

足す： 必須
更新： 必須		 string
FinalAppUrls 将来の使用のために。 AppUrl 配列
FinalMobileUrls モバイル デバイスのランディング ページ URL。

次の検証規則は、最終 URL と最終モバイル URL に適用されます。
- URL の長さは 2,048 文字に制限されています。 HTTP または HTTPS プロトコル文字列は、2,048 文字の制限にカウントされます。
- FinalUrls と FinalMobileUrls の両方に最大 10 個のリスト 項目を指定できます。ただし、各一覧の最初の項目のみが配信に使用されます。 このサービスでは、前方互換性の可能性があるリスト アイテムを最大 10 個まで許可します。
- '{' と '}' の使用は、 {lpurl} などのタグのみを示すために許可されます。
- 最終的な URL はそれぞれ、http:// または https:// で始まる整形式の URL である必要があります。
- FinalMobileUrls を指定する場合は、 FinalUrls も指定する必要があります。
- DevicePreference が 30001 (モバイル) に設定されている場合、FinalMobileUrls を指定することはできません。

足す： 随意
更新： 随意。 更新プログラムに値が設定されていない場合、以前の設定は削除されます。		 string 配列
FinalUrls ランディング ページの URL。

次の検証規則は、最終 URL と最終モバイル URL に適用されます。
- URL の長さは 2,048 文字に制限されています。 HTTP または HTTPS プロトコル文字列は、2,048 文字の制限にカウントされます。
- FinalUrls と FinalMobileUrls の両方に最大 10 個のリスト 項目を指定できます。ただし、各一覧の最初の項目のみが配信に使用されます。 このサービスでは、前方互換性の可能性があるリスト アイテムを最大 10 個まで許可します。
- '{' と '}' の使用は、 {lpurl} などのタグのみを示すために許可されます。
- 最終的な URL はそれぞれ、http:// または https:// で始まる整形式の URL である必要があります。
- FinalMobileUrls を指定する場合は、 FinalUrls も指定する必要があります。
- DevicePreference が 30001 (モバイル) に設定されている場合、FinalMobileUrls を指定することはできません。

足す： 必須
更新： 必須		 string 配列
FinalUrlSuffix 最後の URL サフィックスには、ランディング ページ URL の末尾に追加される追跡パラメーターを含めることができます。 顧客が常にランディング ページに送信されるように、ランディング ページで必要な追跡パラメーターを最終的な URL サフィックスに配置することをお勧めします。 詳細と検証規則については、テクニカル ガイドの 「最終 URL サフィックス」を 参照してください。

この機能は、最終 URL サフィックス フェーズ 3 パイロット (GetCustomerPilotFeatures が 636 を返す) のお客様にのみ使用できます。 パイロットにいない場合、このプロパティは無視され、エラーは返されません。

足す： 随意
更新： 随意。 更新プログラムに値が設定されていない場合、以前の設定は削除されます。		 string
TrackingUrlTemplate すべての FinalUrls と FinalMobileUrls の既定値として使用する追跡テンプレート。

追跡テンプレートには、次の検証規則が適用されます。 サポートされているテンプレートとパラメーターの詳細については、Microsoft Advertising のヘルプ記事「 どのような追跡または URL パラメーターを使用できますか?」を参照してください。
- 低レベルのエンティティに対して定義された追跡テンプレート (広告など) は、キャンペーンなど、上位レベルのエンティティに対して設定されたものをオーバーライドします。 詳細については、「 エンティティの制限」を参照してください。
- 追跡テンプレートの長さは 2,048 文字に制限されています。 HTTP または HTTPS プロトコル文字列は、2,048 文字の制限にカウントされます。
- 追跡テンプレートは、 http://、 https://、 {lpurl}、または {unescapedlpurl} のいずれかで始まる整形式の URL である必要があります。
- Microsoft Advertising では、カスタム パラメーターが存在するかどうかを検証しません。 追跡テンプレートでカスタム パラメーターを使用し、それらが存在しない場合、ランディング ページ URL には、代替なしでカスタム パラメーターのキーと値のプレースホルダーが含まれます。 たとえば、トラッキング テンプレートがでありhttps://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl}、キャンペーン、広告グループ、条件、キーワード (keyword)、または広告レベルで {_season} または {_promocode} が定義されていない場合、ランディング ページの URL は同じになります。

足す： 随意
更新： 随意。 更新プログラムに値が設定されていない場合、以前の設定は削除されます。		 string
UrlCustomParameters URL 追跡用のキーパラメーターと値パラメーターのカスタム コレクション。

Microsoft Advertising では、 CustomParameters オブジェクトに含める最初の 3 つの CustomParameter オブジェクトが受け入れられ、追加のカスタム パラメーターはすべて無視されます。 各 CustomParameter には、Key 要素と Value 要素が含まれています。 カスタム パラメーターの制限の引き上げフェーズ 3 パイロット (GetCustomerPilotFeatures は 635 を返します) のお客様の場合、Microsoft Advertising は、含める最初の 8 つのカスタム パラメーター キーと値のペアを受け入れ、8 つ以上のカスタム パラメーターを含む場合はエラーが返されます。

足す： 随意
更新： 随意。 更新プログラムに値が設定されていない場合、以前の設定は削除されます。		 CustomParameters

SitelinkAdExtension オブジェクトには継承された要素があります。

継承された要素

AdExtension から継承された要素

SitelinkAdExtension オブジェクトは AdExtension オブジェクトから派生し、DevicePreference、ForwardCompatibilityMap、Id、Scheduling、Status、Type、Version の各要素を継承します。 以下の説明は SitelinkAdExtension に固有であり、 AdExtension オブジェクトから同じ要素を継承する他のオブジェクトには適用されない場合があります。

要素 説明 データ型
DevicePreference この要素は、広告拡張機能をモバイル デバイスに表示するか、すべてのデバイスに表示するかを決定します。

モバイル デバイスの基本設定を指定するには、この要素を 30001 に設定します。

すべてのデバイスを指定するには、この要素を 0 (ゼロ) に設定するか、要素 nil のままにします。 既定では、この要素は nil になります。

足す： 随意
更新： 随意。 更新プログラムに値が設定されていない場合、以前の設定は削除されます。		 long
ForwardCompatibilityMap 現在の API バージョンで新しい要素が追加されたときに変更が中断されないように、前方互換性のためのキー文字列と値文字列の一覧。

現在、 AdExtension オブジェクトの前方互換性の変更はありません。

足す： 読み取り専用
更新： 読み取り専用		 KeyValuePairOfstring 配列
身分証明書 広告拡張機能の一意の Microsoft Advertising 識別子。

足す： 読み取り専用
更新： 読み取り専用と必須		 long
スケジュール設定 広告表示オプションが広告に表示される資格があるカレンダーの曜日と時刻の範囲を決定します。

足す： 随意
更新： 随意。 この要素を null に設定した場合、広告拡張機能の既存のスケジュール 設定は変更されません。 これを null 以外の Schedule オブジェクトに設定すると、広告拡張機能の既存のスケジュール設定を実質的に置き換えます。 すべてのスケジュールを削除するには、この要素を空の Schedule オブジェクトに設定します。		 Schedule
Status 広告拡張機能の状態。 キャンペーン管理サービスでは削除された広告表示オプションが返されないため、値は常に アクティブ になります。

足す： 読み取り専用
更新： 読み取り専用		 AdExtensionStatus
型 広告拡張機能の種類。 この値は、サイトリンク広告拡張機能を取得するときの SitelinkAdExtension です。

足す： 読み取り専用
更新： 読み取り専用

広告拡張機能の種類の詳細については、「 広告拡張機能データ オブジェクトの備考」を参照してください。		 string
バージョン 広告拡張機能が更新された回数を追跡します。

バージョンは、広告拡張機能の作成時に 1 に設定され、更新のたびに 1 ずつインクリメントされます。

足す： 禁じられた
更新： 禁じられた		 int

要件

サービス: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13