Export (0) Print
Expand All
Expand Minimize

GetPlacementDetailsForUrls Service Operation

Retrieves placement information for the specified URLs.

Request | Response

Error Codes

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

GetPlacementDetailsForUrlsRequest Message

Request Body

The GetPlacementDetailsForUrlsRequest object defines the elements of the request’s body. The elements must be in the same order as shown in the SOAP example.

Element

Description

Data Type

Urls

An array of URLs from the publisher websites where you want to display your text ads.

You can specify a maximum of 10 URLs, and each URL can contain a maximum of 256 characters. Do not include the protocol in the URL.

string array

Request Header

For information about the values you set the DeveloperToken, Password, and UserName elements to, see Getting Started With the Bing Ads API.

Element

Description

Data Type

ApplicationToken

The application-access token. This header element is not used and should be null.

string

AuthenticationToken

The OAuth access token used to manage Bing Ads accounts linked to a Microsoft Account. For more information, see Managing User Authentication with OAuth.

string

CustomerAccountId

The identifier of the account that owns the entities in the request.

string

CustomerId

The identifier of the customer that owns the account.

string

DeveloperToken

The client application's developer access token.

string

Password

The Bing Ads user's sign-in password.

string

UserName

The Bing Ads user's sign-in user name. You may not set this element to a Microsoft account.

string

Request SOAP

The following example shows the complete request envelope.

<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/v9">
    <Action mustUnderstand="1">GetPlacementDetailsForUrls</Action>
    <ApplicationToken i:nil="false"></ApplicationToken>
    <AuthenticationToken i:nil="false"></AuthenticationToken>
    <CustomerAccountId i:nil="false"></CustomerAccountId>
    <CustomerId i:nil="false"></CustomerId>
    <DeveloperToken i:nil="false"></DeveloperToken>
    <Password i:nil="false"></Password>
    <UserName i:nil="false"></UserName>
  </s:Header>
  <s:Body>
    <GetPlacementDetailsForUrlsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v9">
      <Urls i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:string></a1:string>
      </Urls>
    </GetPlacementDetailsForUrlsRequest>
  </s:Body>
</s:Envelope>

GetPlacementDetailsForUrlsResponse Message

Response Body

Element

Description

Data Type

PlacementDetails

A two-dimensional array of PlacementDetail objects that contains the identifier of the publisher website and the types and sizes of media that the publisher supports.

The first dimension iterates over the publishers and the second dimension iterates over the media types that the publisher supports.

PlacementDetail[][]

Response Header

Element

Description

Data Type

TrackingId

The identifier of the log entry that contains details about the API call.

string

Response SOAP

The following example shows the complete response envelope.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v9">
    <TrackingId p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></TrackingId>
  </s:Header>
  <s:Body>
    <GetPlacementDetailsForUrlsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v9">
      <PlacementDetails p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance">
        <ArrayOfPlacementDetail>
          <PlacementDetail>
            <ImpressionsRangePerDay p4:nil="false">
              <Maximum p4:nil="false"></Maximum>
              <Minimum p4:nil="false"></Minimum>
            </ImpressionsRangePerDay>
            <PathName p4:nil="false"></PathName>
            <PlacementId></PlacementId>
            <SupportedMediaTypes p4:nil="false">
              <MediaType>
                <Dimensions p4:nil="false">
                  <Dimension>
                    <Height></Height>
                    <Width></Width>
                  </Dimension>
                </Dimensions>
                <Name p4:nil="false"></Name>
              </MediaType>
            </SupportedMediaTypes>
          </PlacementDetail>
        </ArrayOfPlacementDetail>
      </PlacementDetails>
    </GetPlacementDetailsForUrlsResponse>
  </s:Body>
</s:Envelope>

Error Codes

If the service operation fails, it throws a FaultException exception, which contains one or more of the Bing Ads API error data objects. For information about the fault detail objects, see Campaign Management Error Data Objects and Handling Service Errors and Exceptions.

The following are example error codes that the error objects can include when using this service operation. For all documented error codes, please see Bing Ads Operation Error Codes.

Error Code

InvalidCredentials

Community Additions

ADD
Show:
© 2014 Microsoft