AddUetTags サービス操作 - キャンペーン管理

[アーティクル]
10/04/2023

Web サイトに追加できる新しいユニバーサルイベント追跡 (UET) タグを追加して、Microsoft Advertising がユーザーが Web サイトで行うアクションを収集できるようにします。

UET タグを作成した後、次の手順は、Web サイトに UET タグ追跡コードを追加することです。 Web サイト管理者または Web サイト管理者は、頭または本文のセクションで Web サイト全体に追加することをお勧めします。 Web サイトにサイト全体のレイアウトページがある場合は、1 回追加し、すべてのページに含めるので、サイト全体のレイアウトページを追加するのに最適な場所です。詳細については、「web サイト操作方法 UET タグを追加する」を参照してください。

すべてのコンバージョン目標とリマーケティングリストで 1 つの UET タグを使用できます。複数の UET タグを作成する前に、「複数の UET タグを作成する理由」を参照してください。

ヒント

実装の概要については、ユニバーサルイベント追跡技術ガイドを参照してください。

Request 要素

AddUetTagsRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。要素は、要求 SOAP に示されている順序と同じ順序である必要があります。

注:

以下に特に記載がない限り、すべての要求要素が必要です。

要求本文要素

要素	説明	データ型
UetTags	顧客の共有 UET タグライブラリに追加する UetTag オブジェクトの配列。顧客は、必要な CustomerId ヘッダー要素によって決定されます。 1 回の通話で最大 100 個の UET タグを追加できますが、すべてのコンバージョン目標とリマーケティングリストで 1 つの UET タグを使用できることに注意してください。複数の UET タグを作成する前に、「複数の UET タグを作成する理由」を参照してください。呼び出しが成功した場合、Web サイトに追加する必要がある追跡スクリプトは、応答メッセージ内の対応する UetTag に含まれます。	UetTag 配列

要求ヘッダー要素

要素	説明	データ型
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 要素

AddUetTagsResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。要素は、応答 SOAP に示されている順序と同じ順序で返されます。

応答本文の要素

要素	説明	データ型
PartialErrors	成功しなかった要求項目の詳細を含む BatchError オブジェクトの配列。エラーの一覧は、要求内の項目の一覧に直接対応していません。エラーがない場合はリストを空にすることも、失敗したリスト項目ごとに対応する 1 つ以上のエラーオブジェクトを要求に含めることもできます。	BatchError 配列
UetTags	顧客の共有 UET タグライブラリに追加する UetTag オブジェクトの配列。顧客は、必要な CustomerId ヘッダー要素によって決定されます。 1 回の通話で最大 100 個の UET タグを追加できますが、すべてのコンバージョン目標とリマーケティングリストで 1 つの UET タグを使用できることに注意してください。複数の UET タグを作成する前に、「複数の UET タグを作成する理由」を参照してください。呼び出しが成功した場合、Web サイトに追加する必要がある追跡スクリプトは、応答メッセージ内の対応する UetTag に含まれます。	UetTag 配列

応答ヘッダー要素

要素	説明	データ型
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">AddUetTags</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>
    <AddUetTagsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <UetTags i:nil="false">
        <UetTag>
          <CustomerShare i:nil="false">
            <CustomerAccountShares i:nil="false">
              <CustomerAccountShare>
                <AccountId i:nil="false">ValueHere</AccountId>
                <Associations i:nil="false">
                  <CustomerAccountShareAssociation>
                    <AssociationCount i:nil="false">ValueHere</AssociationCount>
                    <UsageType i:nil="false">ValueHere</UsageType>
                  </CustomerAccountShareAssociation>
                </Associations>
                <CustomerId i:nil="false">ValueHere</CustomerId>
              </CustomerAccountShare>
            </CustomerAccountShares>
            <OwnerCustomerId i:nil="false">ValueHere</OwnerCustomerId>
          </CustomerShare>
          <Description i:nil="false">ValueHere</Description>
          <Id i:nil="false">ValueHere</Id>
          <Name i:nil="false">ValueHere</Name>
          <TrackingNoScript i:nil="false">ValueHere</TrackingNoScript>
          <TrackingScript i:nil="false">ValueHere</TrackingScript>
          <TrackingStatus i:nil="false">ValueHere</TrackingStatus>
        </UetTag>
      </UetTags>
    </AddUetTagsRequest>
  </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>
    <AddUetTagsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <UetTags d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <UetTag>
          <CustomerShare d4p1:nil="false">
            <CustomerAccountShares d4p1:nil="false">
              <CustomerAccountShare>
                <AccountId d4p1:nil="false">ValueHere</AccountId>
                <Associations d4p1:nil="false">
                  <CustomerAccountShareAssociation>
                    <AssociationCount d4p1:nil="false">ValueHere</AssociationCount>
                    <UsageType d4p1:nil="false">ValueHere</UsageType>
                  </CustomerAccountShareAssociation>
                </Associations>
                <CustomerId d4p1:nil="false">ValueHere</CustomerId>
              </CustomerAccountShare>
            </CustomerAccountShares>
            <OwnerCustomerId d4p1:nil="false">ValueHere</OwnerCustomerId>
          </CustomerShare>
          <Description d4p1:nil="false">ValueHere</Description>
          <Id d4p1:nil="false">ValueHere</Id>
          <Name d4p1:nil="false">ValueHere</Name>
          <TrackingNoScript d4p1:nil="false">ValueHere</TrackingNoScript>
          <TrackingScript d4p1:nil="false">ValueHere</TrackingScript>
          <TrackingStatus d4p1:nil="false">ValueHere</TrackingStatus>
        </UetTag>
      </UetTags>
      <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:e60="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e60:KeyValuePairOfstringstring>
              <e60:key d4p1:nil="false">ValueHere</e60:key>
              <e60:value d4p1:nil="false">ValueHere</e60:value>
            </e60: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>
    </AddUetTagsResponse>
  </s:Body>
</s:Envelope>

コード構文

構文の例は、 Bing広告 SDK で使用できます。その他の例については、「Bing広告 API コードの例」を参照してください。

public async Task<AddUetTagsResponse> AddUetTagsAsync(
	IList<UetTag> uetTags)
{
	var request = new AddUetTagsRequest
	{
		UetTags = uetTags
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.AddUetTagsAsync(r), request));
}

static AddUetTagsResponse addUetTags(
	ArrayOfUetTag uetTags) throws RemoteException, Exception
{
	AddUetTagsRequest request = new AddUetTagsRequest();

	request.setUetTags(uetTags);

	return CampaignManagementService.getService().addUetTags(request);
}

static function AddUetTags(
	$uetTags)
{

	$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];

	$request = new AddUetTagsRequest();

	$request->UetTags = $uetTags;

	return $GLOBALS['CampaignManagementProxy']->GetService()->AddUetTags($request);
}

response=campaignmanagement_service.AddUetTags(
	UetTags=UetTags)

要件

サービス: CampaignManagementService.svc v13
名前空間： https://bingads.microsoft.com/CampaignManagement/v13

次の方法で共有