Export (0) Print
Expand All

KeywordOpportunity Data Object

Defines an object that contains a suggested keyword and bid value.

<xs:complexType name="KeywordOpportunity">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:Opportunity">
      <xs:sequence>
        <xs:element type="xs:long" name="AdGroupId" minOccurs="0"/>
        <xs:element type="xs:long" name="CampaignId" minOccurs="0"/>
        <xs:element type="xs:double" name="Competition" minOccurs="0"/>
        <xs:element type="xs:int" name="MatchType" minOccurs="0"/>
        <xs:element type="xs:long" name="MonthlySearches" minOccurs="0"/>
        <xs:element type="xs:double" name="SuggestedBid" minOccurs="0"/>
        <xs:element type="xs:string" name="SuggestedKeyword" minOccurs="0" nillable="true"/>
        <xs:element type="xs:double" name="AverageCPC" minOccurs="0" nillable="true">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/" EmitDefaultValue="false"/>
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element type="xs:double" name="AverageCTR" minOccurs="0" nillable="true">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/" EmitDefaultValue="false"/>
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element type="xs:double" name="ClickShare" minOccurs="0" nillable="true">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/" EmitDefaultValue="false"/>
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element type="xs:double" name="EstimatedIncreaseInClicks" minOccurs="0" nillable="true">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/" EmitDefaultValue="false"/>
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element type="xs:double" name="EstimatedIncreaseInCost" minOccurs="0" nillable="true">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/" EmitDefaultValue="false"/>
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element type="xs:long" name="EstimatedIncreaseInImpressions" minOccurs="0" nillable="true">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/" EmitDefaultValue="false"/>
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Elements

The KeywordOpportunity object derives from the Opportunity object. For a list of additional elements that you can access, see the Opportunity object.

Element

Description

Data Type

AdGroupId

The identifier of the ad group to apply the suggested keyword to.

long

AverageCPC

Broad match average CPC in the marketplace.

System_CLiX_importantImportant

By default this element is not returned within the KeywordOpportunity Data Object. This element is only returned within the BroadMatchKeywordOpportunity Data Object, which derives from KeywordOpportunity.

double

AverageCTR

Broad match average CTR in the marketplace.

System_CLiX_importantImportant

By default this element is not returned within the KeywordOpportunity Data Object. This element is only returned within the BroadMatchKeywordOpportunity Data Object, which derives from KeywordOpportunity.

double

CampaignId

The identifier of the campaign that owns the ad group.

long

ClickShare

Broad match click share in the marketplace.

System_CLiX_importantImportant

By default this element is not returned within the KeywordOpportunity Data Object. This element is only returned within the BroadMatchKeywordOpportunity Data Object, which derives from KeywordOpportunity.

double

Competition

An indicator of competitive bids for this keyword relative to all search keywords. The competition score ranges from 0 to 1.00, where 0 indicates low competition and 1.00 indicates that there is a high number of advertisers competing for this keyword.

double

EstimatedIncreaseInClicks

Estimated increase in clicks if the opportunity is applied.

long

EstimatedIncreaseInCost

Estimated increase in cost if the opportunity is applied.

long

EstimatedIncreaseInImpressions

Estimated increase in impressions if the opportunity is applied.

long

MatchType

The match type that the suggested bid applies to. The following are the possible match-type values.

  • 1 – Exact match

  • 2 – Phrase match

  • 3 – Broad match

int

MonthlySearches

The estimated monthly volume of user search queries that may match the suggested keyword for the corresponding MatchType element.

long

SuggestedBid

The suggested bid that may result in your ads serving on the first page of the search query results.

double

SuggestedKeyword

The suggested keyword.

string

Requirements

OptimizerService.svc v9

Namespace: https://bingads.microsoft.com/Optimizer/v9

Community Additions

ADD
Show:
© 2015 Microsoft