Export (0) Print
Expand All
Expand Minimize

GetEditorialReasonsByIds Service Operation

Gets the reasons why the specified entities failed editorial review and whether the rejection is appealable.

Request | Response

Error Codes

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

GetEditorialReasonsByIdsRequest Message

Request Body

The GetEditorialReasonsByIdsRequest 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

AccountId

The identifier of the account that contains the specified entities.

long

EntityIds

A list of unique identifiers that identifies the ads or keywords that failed editorial review. The list must include all ads or all keywords – the list cannot include a mix ads and keywords. The list can contain a maximum of 1,000 identifiers.

long array

EntityType

The type of entities that the entity list contains.

EntityType

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">GetEditorialReasonsByIds</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>
    <GetEditorialReasonsByIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v9">
      <AccountId></AccountId>
      <EntityIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long></a1:long>
      </EntityIds>
      <EntityType></EntityType>
    </GetEditorialReasonsByIdsRequest>
  </s:Body>
</s:Envelope>

GetEditorialReasonsByIdsResponse Message

Response Body

Element

Description

Data Type

EditorialReasons

A collection of ads or keywords that failed editorial review. The object identifies the reason for the failure and whether it is appealable.

The items of this collection correspond directly to the list of entity identifiers in the request. If the entity did not fail editorial review, the corresponding item in this collection is NULL. In addition, the item will be NULL if the specified ad or keyword identifier is not valid.

EditorialReasonCollection array

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>
    <GetEditorialReasonsByIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v9">
      <EditorialReasons p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance">
        <EditorialReasonCollection>
          <AdOrKeywordId></AdOrKeywordId>
          <AppealStatus></AppealStatus>
          <Reasons p4:nil="false">
            <EditorialReason>
              <Location p4:nil="false"></Location>
              <PublisherCountries p4:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <a1:string></a1:string>
              </PublisherCountries>
              <ReasonCode></ReasonCode>
              <Term p4:nil="false"></Term>
            </EditorialReason>
          </Reasons>
        </EditorialReasonCollection>
      </EditorialReasons>
    </GetEditorialReasonsByIdsResponse>
  </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