ApplyOfflineConversions サービス操作 - キャンペーン管理
他のオフラインコンバージョンデータの中でも、Microsoft Click Id を使用してアカウントのオフラインコンバージョンを適用します。
たとえば、ユーザーが広告を見てクリックしたが、最終的にユーザーに電話を掛け、オフラインになった販売に至ったとします。 検索広告がウェブサイトの外でオフラインでコンバージョンにつながったタイミングを追跡するにはどうすればよいですか? オフライン コンバージョンをインポートして、広告がクリックされた後の動作をより適切に測定できます。
OfflineConversionGoal を作成したら、Microsoft Advertising にオフライン コンバージョンを送信するまで 2 時間待つ必要があります。 2 時間待たないと、オフライン変換データが適用されない可能性があります。 オフライン コンバージョンを Microsoft Advertising に送信した後、コンバージョン データを表示するには最大 6 時間かかることがあります。
各オフライン変換は、複数のクリック ID に分割できます。 ただし、1 回のクリック ID は、変換時間が異なる限り、複数のコンバージョン目標に関連付けることができ、同じ目標に複数回関連付けることができます。 また、同じ変換を複数回インポートすることはできません。 複数のインスタンスが試行された場合、最初のインスタンスが使用され、他のインスタンスは無視されます。
変換の値は、カスタム通貨と共にインポート ファイルに含めることができます。 通貨が明記されていない場合は、コンバージョン目標の既定値が使用されます。
詳細については、「 オフライン コンバージョンの追跡」を参照してください。
Request 要素
ApplyOfflineConversionsRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。 要素は、 要求 SOAP に示されている順序と同じ順序である必要があります。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
要素 | 説明 | データ型 |
---|---|---|
OfflineConversions | アカウントのオフライン コンバージョンの一覧。 サービス要求ごとに最大 1,000 個のオフラインコンバージョンを追加できます。 各オフライン変換は、複数のクリック ID に分割できます。 ただし、1 回のクリック ID は、変換時間が異なる限り、複数のコンバージョン目標に関連付けることができ、同じ目標に複数回関連付けることができます。 また、同じ変換を複数回適用することはできません。 Microsoft Advertising の重複を送信すると、最初のインスタンスが使用され、他のインスタンスは無視されます。 |
OfflineConversion 配列 |
要求ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
AuthenticationToken | Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセス トークン。 詳細については、「 OAuth による認証」を参照してください。 |
string |
CustomerAccountId | 要求のエンティティを所有または関連付けられている広告アカウントの識別子。 両方が必要な場合、このヘッダー要素の値は AccountId 本文要素と同じである必要があります。 この要素は、ほとんどのサービス操作に必要であり、ベスト プラクティスとして常に設定する必要があります。 詳細については、「 アカウントと顧客 ID を取得する」を参照してください。 |
string |
Customerid | ユーザーがアクセスまたは操作しているマネージャー アカウント (顧客) の識別子。 ユーザーは複数のマネージャー アカウントにアクセスできます。 この要素は、ほとんどのサービス操作に必要であり、ベスト プラクティスとして常に設定する必要があります。 詳細については、「 アカウントと顧客 ID を取得する」を参照してください。 |
string |
DeveloperToken | Bing Ads API へのアクセスに使用される開発者トークン。 詳細については、「 開発者トークンを取得する」を参照してください。 |
string |
Password | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
UserName | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
Response 要素
ApplyOfflineConversionsResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 応答 SOAP に示されている順序と同じ順序で返されます。
応答本文の要素
要素 | 説明 | データ型 |
---|---|---|
PartialErrors | 成功しなかった要求項目の詳細を含む BatchError オブジェクトの配列。 エラーの一覧は、要求内の項目の一覧に直接対応していません。 エラーがない場合はリストを空にすることも、失敗したリスト 項目ごとに対応する 1 つ以上のエラー オブジェクトを要求に含めることもできます。 |
BatchError 配列 |
応答ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
TrackingId | API 呼び出しの詳細を含むログ エントリの識別子。 | string |
SOAP を要求する
このテンプレートは、SOAP 要求の本文要素とヘッダー要素の順序を示すツールによって生成されました。 このサービス操作で使用できるサポートされる型については、上記の 要求本文要素 のリファレンスを参照してください。
<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<Action mustUnderstand="1">ApplyOfflineConversions</Action>
<AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
<CustomerAccountId i:nil="false">ValueHere</CustomerAccountId>
<CustomerId i:nil="false">ValueHere</CustomerId>
<DeveloperToken i:nil="false">ValueHere</DeveloperToken>
</s:Header>
<s:Body>
<ApplyOfflineConversionsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<OfflineConversions i:nil="false">
<OfflineConversion>
<ConversionCurrencyCode i:nil="false">ValueHere</ConversionCurrencyCode>
<ConversionName i:nil="false">ValueHere</ConversionName>
<ConversionTime>ValueHere</ConversionTime>
<ConversionValue i:nil="false">ValueHere</ConversionValue>
<ExternalAttributionCredit i:nil="false">ValueHere</ExternalAttributionCredit>
<ExternalAttributionModel i:nil="false">ValueHere</ExternalAttributionModel>
<HashedEmailAddress i:nil="false">ValueHere</HashedEmailAddress>
<HashedPhoneNumber i:nil="false">ValueHere</HashedPhoneNumber>
<MicrosoftClickId i:nil="false">ValueHere</MicrosoftClickId>
</OfflineConversion>
</OfflineConversions>
</ApplyOfflineConversionsRequest>
</s:Body>
</s:Envelope>
応答 SOAP
このテンプレートは、SOAP 応答の 本文 要素と ヘッダー 要素の順序を示すツールによって生成されました。
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
</s:Header>
<s:Body>
<ApplyOfflineConversionsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<PartialErrors d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<BatchError d4p1:type="-- derived type specified here with the appropriate prefix --">
<Code>ValueHere</Code>
<Details d4p1:nil="false">ValueHere</Details>
<ErrorCode d4p1:nil="false">ValueHere</ErrorCode>
<FieldPath d4p1:nil="false">ValueHere</FieldPath>
<ForwardCompatibilityMap xmlns:e68="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e68:KeyValuePairOfstringstring>
<e68:key d4p1:nil="false">ValueHere</e68:key>
<e68:value d4p1:nil="false">ValueHere</e68:value>
</e68:KeyValuePairOfstringstring>
</ForwardCompatibilityMap>
<Index>ValueHere</Index>
<Message d4p1:nil="false">ValueHere</Message>
<Type d4p1:nil="false">ValueHere</Type>
<!--These fields are applicable if the derived type attribute is set to EditorialError-->
<Appealable d4p1:nil="false">ValueHere</Appealable>
<DisapprovedText d4p1:nil="false">ValueHere</DisapprovedText>
<Location d4p1:nil="false">ValueHere</Location>
<PublisherCountry d4p1:nil="false">ValueHere</PublisherCountry>
<ReasonCode>ValueHere</ReasonCode>
</BatchError>
</PartialErrors>
</ApplyOfflineConversionsResponse>
</s:Body>
</s:Envelope>
コード構文
構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。
public async Task<ApplyOfflineConversionsResponse> ApplyOfflineConversionsAsync(
IList<OfflineConversion> offlineConversions)
{
var request = new ApplyOfflineConversionsRequest
{
OfflineConversions = offlineConversions
};
return (await CampaignManagementService.CallAsync((s, r) => s.ApplyOfflineConversionsAsync(r), request));
}
static ApplyOfflineConversionsResponse applyOfflineConversions(
ArrayOfOfflineConversion offlineConversions) throws RemoteException, Exception
{
ApplyOfflineConversionsRequest request = new ApplyOfflineConversionsRequest();
request.setOfflineConversions(offlineConversions);
return CampaignManagementService.getService().applyOfflineConversions(request);
}
static function ApplyOfflineConversions(
$offlineConversions)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new ApplyOfflineConversionsRequest();
$request->OfflineConversions = $offlineConversions;
return $GLOBALS['CampaignManagementProxy']->GetService()->ApplyOfflineConversions($request);
}
response=campaignmanagement_service.ApplyOfflineConversions(
OfflineConversions=OfflineConversions)
要件
サービス: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13