Skip to content

Latest commit

 

History

History
181 lines (157 loc) · 8.36 KB

getuettagsbyids.md

File metadata and controls

181 lines (157 loc) · 8.36 KB
Raw
title ms.service ms.subservice ms.topic author ms.author description dev_langs
GetUetTagsByIds Service Operation - Campaign Management
bing-ads
campaign-management-api
article
jonmeyers
jonmeyers
Gets the specified Universal Event Tracking (UET) tags.
csharp
java
php
python

GetUetTagsByIds Service Operation - Campaign Management

Gets the specified Universal Event Tracking (UET) tags.

Tip

For an implementation overview, see the Universal Event Tracking technical guide.

Request Elements

The GetUetTagsByIdsRequest object defines the body and header elements of the service operation request. The elements must be in the same order as shown in the Request SOAP.

Note

Unless otherwise noted below, all request elements are required.

Request Body Elements

Element Description Data Type
TagIds A maximum of 100 identifiers of the UET tags that you want to get.

If TagIds is null or empty, then you are effectively requesting all UET tags that are available for the customer.		 long array

Request Header Elements

[!INCLUDErequest-header]

Response Elements

The GetUetTagsByIdsResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response SOAP.

Response Body Elements

Element Description Data Type
PartialErrors An array of BatchError objects that contain details for any request items that were not successful.

The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.		 BatchError array
UetTags An array of UetTag objects that corresponds directly to the UET tag identifiers that you specified in the request. Items of the array may be returned as null. For each array index where a UET tag was not retrieved, the corresponding element will be null. UetTag array

Response Header Elements

[!INCLUDEresponse-header]

Request SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP request. For supported types that you can use with this service operation, see the Request Body Elements reference above.

<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">GetUetTagsByIds</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>
    <GetUetTagsByIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <TagIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </TagIds>
    </GetUetTagsByIdsRequest>
  </s:Body>
</s:Envelope>

Response SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP response.

<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>
    <GetUetTagsByIdsResponse 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:e170="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e170:KeyValuePairOfstringstring>
              <e170:key d4p1:nil="false">ValueHere</e170:key>
              <e170:value d4p1:nil="false">ValueHere</e170:value>
            </e170: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>
    </GetUetTagsByIdsResponse>
  </s:Body>
</s:Envelope>

Code Syntax

The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.

public async Task<GetUetTagsByIdsResponse> GetUetTagsByIdsAsync(
	IList<long> tagIds)
{
	var request = new GetUetTagsByIdsRequest
	{
		TagIds = tagIds
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.GetUetTagsByIdsAsync(r), request));
}
static GetUetTagsByIdsResponse getUetTagsByIds(
	ArrayOflong tagIds) throws RemoteException, Exception
{
	GetUetTagsByIdsRequest request = new GetUetTagsByIdsRequest();

	request.setTagIds(tagIds);

	return CampaignManagementService.getService().getUetTagsByIds(request);
}
static function GetUetTagsByIds(
	$tagIds)
{

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

	$request = new GetUetTagsByIdsRequest();

	$request->TagIds = $tagIds;

	return $GLOBALS['CampaignManagementProxy']->GetService()->GetUetTagsByIds($request);
}
response=campaignmanagement_service.GetUetTagsByIds(
	TagIds=TagIds)

Requirements

Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13