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

  • [アーティクル]

キーワードを定義します。

キーワードは、製品またはサービスを探すときに検索される単語または語句です。 たとえば、キーワードは次のいずれかになります。

  • 靴
  • ボートクルーズ休暇
  • ニューヨークでのテニスレッスン

上に示したように、キーワード (keyword)は単一の単語、複数の単語、または語句です。 検索広告のコンテキストでは、これらのすべてが単にキーワード (keyword)と呼ばれます。

重要

2021 年 4 月の時点で、広告グループやキーワードに対して入札戦略を設定することはできません。 広告グループまたはキーワードの入札戦略を設定しようとすると、要求はエラーなしで無視されます。 広告グループとキーワードは、キャンペーンの入札戦略を継承します。

構文

<xs:complexType name="Keyword" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="Bid" nillable="true" type="tns:Bid" />
    <xs:element minOccurs="0" name="BiddingScheme" nillable="true" type="tns:BiddingScheme" />
    <xs:element minOccurs="0" name="DestinationUrl" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="EditorialStatus" nillable="true" type="tns:KeywordEditorialStatus" />
    <xs:element minOccurs="0" name="FinalAppUrls" nillable="true" type="tns:ArrayOfAppUrl" />
    <xs:element xmlns:q32="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalMobileUrls" nillable="true" type="q32:ArrayOfstring" />
    <xs:element minOccurs="0" name="FinalUrlSuffix" nillable="true" type="xs:string" />
    <xs:element xmlns:q33="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalUrls" nillable="true" type="q33:ArrayOfstring" />
    <xs:element xmlns:q34="http://schemas.datacontract.org/2004/07/System.Collections.Generic" minOccurs="0" name="ForwardCompatibilityMap" nillable="true" type="q34:ArrayOfKeyValuePairOfstringstring" />
    <xs:element minOccurs="0" name="Id" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="MatchType" nillable="true" type="tns:MatchType" />
    <xs:element minOccurs="0" name="Param1" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="Param2" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="Param3" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="Status" nillable="true" type="tns:KeywordStatus" />
    <xs:element minOccurs="0" name="Text" nillable="true" type="xs:string" />
    <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:complexType>

要素

Keyword オブジェクトには、Bid、BidScheme、DestinationUrl、EditorialStatus、FinalAppUrls、FinalMobileUrls、FinalUrls、FinalUrlSuffix、ForwardCompatibilityMap、Id、MatchType、Param1、Param2、Param3、Status、Text、TrackingUrlTemplate、UrlCustomParameters という要素があります。

要素 説明 データ型
入札 ユーザーが広告をクリックするたびに支払う最大金額。

同じキーワード (keyword)を使用して他の広告主に対して入札を行うので、一般的に高い入札単価を設定すると、検索結果ページのより望ましい場所に広告が表示されます。

既定の広告グループ レベルの入札を使用する代わりに、キーワード (keyword)ごとにカスタム入札を設定できます。 キーワードのカスタム入札は、これらの特定のキーワードの広告グループの既定の入札よりも優先されます。 カスタム入札では、最も収益性の高いキーワードに時間とお金を集中させることができますが、個々の入札の管理にもっと時間を費やす必要があります。

キーワード (keyword)レベルの入札が設定されていない場合は、広告グループのクリック単価が使用されます。 詳細については、「 予算と入札戦略」を参照してください。

足す： 随意
更新： 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。 キーワード (keyword)の入札を削除し、AdGroup の既定の一致タイプの入札を使用するには、Bid オブジェクトの Amount 要素を null に設定します。		 Bid
BiddingScheme 入札を管理する方法の入札戦略の種類。

キャンペーンの種類ごとにサポートされている入札戦略の詳細については、「 予算と入札戦略」を参照してください。

手記： 2021 年 4 月の時点で、広告グループやキーワードに対して入札戦略を設定することはできません。 広告グループまたはキーワードの入札戦略を設定しようとすると、要求はエラーなしで無視されます。 広告グループとキーワードは、キャンペーンの入札戦略を継承します。

足す： 随意。 この要素を設定しない場合、 InheritFromParentBiddingScheme が既定で使用されます。
更新： 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。		 BiddingScheme
DestinationUrl ユーザーが広告をクリックしたときにアクセスする Web ページの URL。 指定した場合は、キーワード (keyword)の宛先 URL が使用されます。それ以外の場合は、広告の宛先 URL が使用されます。

大事な：2018 年 11 月の時点で、キーワード (keyword)宛先 URL を追加または更新できません。 代わりに 、Final URL を 使用できます。 詳細については、「キーワード (keyword)宛先 URL を最終的な URL に移行する」を参照してください。

足す： 禁じられた
更新： 禁じられた		 string
EditorialStatus キーワード (keyword)の編集レビューの状態。これは、キーワード (keyword)がレビュー待ちであるか、承認されているか、不承認であるかを示します。

足す： 読み取り専用
更新： 読み取り専用		 KeywordEditorialStatus
FinalAppUrls 将来の使用のために。 AppUrl 配列
FinalMobileUrls モバイル ランディング ページの URL。 キーワード (keyword)の最終モバイル URL が指定されている場合は使用されます。それ以外の場合は、広告の最終的なモバイル URL が使用されます。

足す： 随意
更新： 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。		 string 配列
FinalUrls ランディング ページの URL。 キーワード (keyword)の最終 URL が指定されている場合は使用されます。それ以外の場合は、広告の最終的な URL が使用されます。

次の検証規則は、最終 URL と最終モバイル URL に適用されます。
- URL の長さは 2,048 文字に制限されています。 HTTP または HTTPS プロトコル文字列は、2,048 文字の制限にカウントされます。
- FinalUrls と FinalMobileUrls の両方に最大 10 個の項目を指定できます。ただし、各一覧の最初の項目のみが配信に使用されます。 このサービスでは、前方互換性の可能性がある最大 10 個を許可します。
- '{' と '}' の使用は、 {lpurl} などのタグのみを示すために許可されます。
- 最終的な URL はそれぞれ、http:// または https:// で始まる整形式の URL である必要があります。
- FinalMobileUrls を指定する場合は、 FinalUrls も指定する必要があります。
- デバイスの基本設定がモバイルに設定されている場合、 FinalMobileUrls を指定することはできません。 また、 TrackingUrlTemplate 要素または UrlCustomParameters 要素が設定されている場合は、少なくとも 1 つの最終的な URL が必要であることに注意してください。 詳細については、「 アップグレードされた URL を使用した URL 追跡」を参照してください。

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

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

今後のリリースでは、今後の互換性の変更に関するページを参照してください。 現在、このオブジェクトの前方互換性の変更はありません。		 KeyValuePairOfstring 配列
身分証明書 キーワード (keyword)のシステム生成識別子。

足す： 読み取り専用
更新： 必須		 long
MatchType キーワード (keyword)とユーザーの検索用語を比較する一致の種類。

足す： 必須
更新： 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。		 MatchType
Param1 広告のタイトル、テキスト、表示 URL、または宛先 URL に {Param1} 動的置換文字列が含まれている場合に、広告の置換値として使用する文字列。

{Param1} を使用して広告の宛先 URL を指定できますが、指定しないことをお勧めします。 代わりに、キーワード (keyword)の DestinationUrl 要素を設定する必要があります。

文字列には、最大 1,022 文字を含めることができます。 実際の制限は、置換文字列を参照する要素の長さによって異なります。 たとえば、テキスト広告のタイトルの長さは最大 25 文字です。

広告コピーに動的テキストを実装する場合は、既定の文字列 (例: {Param1:default} を指定する必要があります。たとえば、キーワード (keyword)の Param1 が null または空の場合、または Param1 置換値を含めると、展開された文字列が要素の制限を超える場合、広告はこのキーワード (keyword)で機能しません。 詳細については、Microsoft Advertising のヘルプ記事「 動的テキスト パラメーターを使用して広告を自動的にカスタマイズする」を参照してください。

また、広告グループに広告が 1 つだけあり、その広告で {Param1} が使用されているが、既定の文字列 ({Param1:default} など) が指定されていない場合は、その置換に有効な Param1 値を指定する必要があることに注意してください。 それ以外の場合、このキーワード (keyword)を追加または更新することはできません。

足す： 随意
更新： 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。 この要素を空の文字列 ("") に設定すると、前の設定が削除されます。		 string
Param2 タイトル、テキスト、表示 URL、または宛先 URL に {Param2} 動的置換文字列が含まれている場合に、広告の置換値として使用する文字列。

通常、{Param2} 置換文字列は、広告のタイトル要素またはテキスト (広告コピーの説明) 要素で使用します。

文字列には、最大 70 文字を含めることができます。 実際の制限は、置換文字列を参照する要素の長さによって異なります。 たとえば、テキスト広告のタイトルの長さは最大 25 文字です。

広告コピーに動的テキストを実装する場合は、既定の文字列 (例: {Param2:default} を指定する必要があります。たとえば、キーワード (keyword)の Param2 が null または空の場合、または Param2 置換値を含めると展開された文字列が要素の制限を超える場合、広告はこのキーワード (keyword)で機能しません。 詳細については、Microsoft Advertising のヘルプ記事「 動的テキスト パラメーターを使用して広告を自動的にカスタマイズする」を参照してください。

また、広告グループに広告が 1 つだけあり、その広告で {Param2} が使用されているが、既定の文字列 ({Param2:default} など) が指定されていない場合は、その置換に有効な Param2 値を指定する必要があります。 それ以外の場合、このキーワード (keyword)を追加または更新することはできません。

足す： 随意
更新： 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。 この要素を空の文字列 ("") に設定すると、前の設定が削除されます。		 string
Param3 タイトル、テキスト、表示 URL、または宛先 URL に {Param3} 動的置換文字列が含まれている場合、広告の置換値として使用する文字列。

通常、{Param3} 置換文字列は、広告のタイトル要素またはテキスト (広告コピーの説明) 要素で使用します。

文字列には、最大 70 文字を含めることができます。 実際の制限は、置換文字列を参照する要素の長さによって異なります。 たとえば、テキスト広告のタイトルの長さは最大 25 文字です。

広告コピーに動的テキストを実装する場合は、既定の文字列 (例: {Param3:default} を指定する必要があります。たとえば、キーワード (keyword)の Param3 が null または空の場合、または Param3 置換値を含めると展開された文字列が要素の制限を超える場合、広告はこのキーワード (keyword)で機能しません。 詳細については、Microsoft Advertising のヘルプ記事「 動的テキスト パラメーターを使用して広告を自動的にカスタマイズする」を参照してください。

また、広告グループに広告が 1 つだけあり、その広告で {Param3} が使用されているが、既定の文字列 (例: {Param3:default}) が指定されていない場合は、その置換に有効な Param3 値を指定する必要があることに注意してください。 それ以外の場合、このキーワード (keyword)を追加または更新することはできません。

足す： 随意
更新： 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。 この要素を空の文字列 ("") に設定すると、前の設定が削除されます。		 string
Status キーワード (keyword)の状態。 既定では、状態は [アクティブ] に設定されています。

足す： 随意
更新： 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。		 KeywordStatus
テキスト キーワード (keyword)テキスト。 テキストには最大 100 文字を含めることができます。 キーワード (keyword)が属する広告グループに指定した言語値のロケールで、キーワード (keyword)を指定する必要があります。

足す： 必須
更新： 読み取り専用		 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 オブジェクトに含める最初の 8 個の CustomParameter オブジェクトを受け入れ、8 つ以上のカスタム パラメーターを含める場合はエラーが返されます。 各 CustomParameter には、Key 要素と Value 要素が含まれています。

足す： 随意
更新： 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。 既存のカスタム パラメーターを保持するには、 UrlCustomParameters 要素を null または空に設定します。 すべてのカスタム パラメーターを削除するには、CustomParameters オブジェクトの Parameters 要素を null または空に設定します。 カスタム パラメーターのサブセットを削除するには、CustomParameters オブジェクトの Parameters 要素に保持するカスタム パラメーターを指定します。		 CustomParameters

要件

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

使用ページ

AddKeywords
GetKeywordsByAdGroupId
GetKeywordsByEditorialStatus
GetKeywordsByIds
UpdateKeywords