GetAdsByEditorialStatus Service Operation - Campaign Management

Статья
11/13/2024

Retrieves the ads that belong to the specified ad group and have the specified editorial review status.

Request Elements

The GetAdsByEditorialStatusRequest 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
AdGroupId	The identifier of the ad group to retrieve the ads from.	long
AdTypes	One or more types of ads to return.	AdType array
EditorialStatus	The editorial review status that the ads must have to be returned.	AdEditorialStatus
ReturnAdditionalFields	The additional field values enable you to get the latest features using the current version of Campaign Management API, and in the next version the corresponding elements will be included by default. This request element is optional.	AdAdditionalField

Request Header Elements

Element	Description	Data Type
AuthenticationToken	The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. For more information see Authentication with OAuth.	string
CustomerAccountId	The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs.	string
CustomerId	The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs.	string
DeveloperToken	The developer token used to access the Bing Ads API. For more information see Get a Developer Token.	string
Password	This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials.	string
UserName	This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials.	string

Response Elements

The GetAdsByEditorialStatusResponse 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
Ads	The list of ads that have been retrieved. If the ad group doesn't contain ads that meet the criteria, this array is empty.	Ad array

Response Header Elements

Element	Description	Data Type
TrackingId	The identifier of the log entry that contains the details of the API call.	string

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">GetAdsByEditorialStatus</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>
    <GetAdsByEditorialStatusRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <AdGroupId>ValueHere</AdGroupId>
      <EditorialStatus>ValueHere</EditorialStatus>
      <AdTypes i:nil="false">
        <AdType>ValueHere</AdType>
      </AdTypes>
      <ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
    </GetAdsByEditorialStatusRequest>
  </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>
    <GetAdsByEditorialStatusResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <Ads d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <Ad d4p1:type="-- derived type specified here with the appropriate prefix --">
          <AdFormatPreference d4p1:nil="false">ValueHere</AdFormatPreference>
          <DevicePreference d4p1:nil="false">ValueHere</DevicePreference>
          <EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
          <FinalAppUrls d4p1:nil="false">
            <AppUrl>
              <OsType d4p1:nil="false">ValueHere</OsType>
              <Url d4p1:nil="false">ValueHere</Url>
            </AppUrl>
          </FinalAppUrls>
          <FinalMobileUrls d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a1:string>ValueHere</a1:string>
          </FinalMobileUrls>
          <FinalUrlSuffix d4p1:nil="false">ValueHere</FinalUrlSuffix>
          <FinalUrls d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a1:string>ValueHere</a1:string>
          </FinalUrls>
          <ForwardCompatibilityMap xmlns:e237="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e237:KeyValuePairOfstringstring>
              <e237:key d4p1:nil="false">ValueHere</e237:key>
              <e237:value d4p1:nil="false">ValueHere</e237:value>
            </e237:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Id d4p1:nil="false">ValueHere</Id>
          <Status d4p1:nil="false">ValueHere</Status>
          <TrackingUrlTemplate d4p1:nil="false">ValueHere</TrackingUrlTemplate>
          <Type d4p1:nil="false">ValueHere</Type>
          <UrlCustomParameters d4p1:nil="false">
            <Parameters d4p1:nil="false">
              <CustomParameter>
                <Key d4p1:nil="false">ValueHere</Key>
                <Value d4p1:nil="false">ValueHere</Value>
              </CustomParameter>
            </Parameters>
          </UrlCustomParameters>
          <!--These fields are applicable if the derived type attribute is set to TextAd-->
          <DestinationUrl d4p1:nil="false">ValueHere</DestinationUrl>
          <DisplayUrl d4p1:nil="false">ValueHere</DisplayUrl>
          <Text d4p1:nil="false">ValueHere</Text>
          <Title d4p1:nil="false">ValueHere</Title>
          <!--This field is applicable if the derived type attribute is set to ProductAd-->
          <PromotionalText d4p1:nil="false">ValueHere</PromotionalText>
          <!--No additional fields are applicable if the derived type attribute is set to HotelAd-->
          <!--These fields are applicable if the derived type attribute is set to AppInstallAd-->
          <AppPlatform d4p1:nil="false">ValueHere</AppPlatform>
          <AppStoreId d4p1:nil="false">ValueHere</AppStoreId>
          <Text d4p1:nil="false">ValueHere</Text>
          <Title d4p1:nil="false">ValueHere</Title>
          <!--These fields are applicable if the derived type attribute is set to ExpandedTextAd-->
          <Domain d4p1:nil="false">ValueHere</Domain>
          <Path1 d4p1:nil="false">ValueHere</Path1>
          <Path2 d4p1:nil="false">ValueHere</Path2>
          <Text d4p1:nil="false">ValueHere</Text>
          <TextPart2 d4p1:nil="false">ValueHere</TextPart2>
          <TitlePart1 d4p1:nil="false">ValueHere</TitlePart1>
          <TitlePart2 d4p1:nil="false">ValueHere</TitlePart2>
          <TitlePart3 d4p1:nil="false">ValueHere</TitlePart3>
          <!--These fields are applicable if the derived type attribute is set to DynamicSearchAd-->
          <Path1 d4p1:nil="false">ValueHere</Path1>
          <Path2 d4p1:nil="false">ValueHere</Path2>
          <Text d4p1:nil="false">ValueHere</Text>
          <TextPart2 d4p1:nil="false">ValueHere</TextPart2>
          <!--These fields are applicable if the derived type attribute is set to ResponsiveAd-->
          <AdSubType d4p1:nil="false">ValueHere</AdSubType>
          <BusinessName d4p1:nil="false">ValueHere</BusinessName>
          <CallToAction d4p1:nil="false">ValueHere</CallToAction>
          <CallToActionLanguage d4p1:nil="false">ValueHere</CallToActionLanguage>
          <Descriptions d4p1:nil="false">
            <AssetLink>
              <Asset d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
                <Id d4p1:nil="false">ValueHere</Id>
                <Name d4p1:nil="false">ValueHere</Name>
                <Type d4p1:nil="false">ValueHere</Type>
                <!--This field is applicable if the derived type attribute is set to TextAsset-->
                <Text d4p1:nil="false">ValueHere</Text>
                <!--These fields are applicable if the derived type attribute is set to ImageAsset-->
                <CropHeight d4p1:nil="false">ValueHere</CropHeight>
                <CropWidth d4p1:nil="false">ValueHere</CropWidth>
                <CropX d4p1:nil="false">ValueHere</CropX>
                <CropY d4p1:nil="false">ValueHere</CropY>
                <SubType d4p1:nil="false">ValueHere</SubType>
                <TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
                <TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
                <!--These fields are applicable if the derived type attribute is set to VideoAsset-->
                <SubType d4p1:nil="false">ValueHere</SubType>
                <ThumbnailImage d4p1:nil="false">
                  <CropHeight d4p1:nil="false">ValueHere</CropHeight>
                  <CropWidth d4p1:nil="false">ValueHere</CropWidth>
                  <CropX d4p1:nil="false">ValueHere</CropX>
                  <CropY d4p1:nil="false">ValueHere</CropY>
                  <SubType d4p1:nil="false">ValueHere</SubType>
                  <TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
                  <TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
                </ThumbnailImage>
              </Asset>
              <AssetPerformanceLabel d4p1:nil="false">ValueHere</AssetPerformanceLabel>
              <EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
              <PinnedField d4p1:nil="false">ValueHere</PinnedField>
            </AssetLink>
          </Descriptions>
          <Headline d4p1:nil="false">ValueHere</Headline>
          <Headlines d4p1:nil="false">
            <AssetLink>
              <Asset d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
                <Id d4p1:nil="false">ValueHere</Id>
                <Name d4p1:nil="false">ValueHere</Name>
                <Type d4p1:nil="false">ValueHere</Type>
                <!--This field is applicable if the derived type attribute is set to TextAsset-->
                <Text d4p1:nil="false">ValueHere</Text>
                <!--These fields are applicable if the derived type attribute is set to ImageAsset-->
                <CropHeight d4p1:nil="false">ValueHere</CropHeight>
                <CropWidth d4p1:nil="false">ValueHere</CropWidth>
                <CropX d4p1:nil="false">ValueHere</CropX>
                <CropY d4p1:nil="false">ValueHere</CropY>
                <SubType d4p1:nil="false">ValueHere</SubType>
                <TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
                <TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
                <!--These fields are applicable if the derived type attribute is set to VideoAsset-->
                <SubType d4p1:nil="false">ValueHere</SubType>
                <ThumbnailImage d4p1:nil="false">
                  <CropHeight d4p1:nil="false">ValueHere</CropHeight>
                  <CropWidth d4p1:nil="false">ValueHere</CropWidth>
                  <CropX d4p1:nil="false">ValueHere</CropX>
                  <CropY d4p1:nil="false">ValueHere</CropY>
                  <SubType d4p1:nil="false">ValueHere</SubType>
                  <TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
                  <TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
                </ThumbnailImage>
              </Asset>
              <AssetPerformanceLabel d4p1:nil="false">ValueHere</AssetPerformanceLabel>
              <EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
              <PinnedField d4p1:nil="false">ValueHere</PinnedField>
            </AssetLink>
          </Headlines>
          <Images d4p1:nil="false">
            <AssetLink>
              <Asset d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
                <Id d4p1:nil="false">ValueHere</Id>
                <Name d4p1:nil="false">ValueHere</Name>
                <Type d4p1:nil="false">ValueHere</Type>
                <!--This field is applicable if the derived type attribute is set to TextAsset-->
                <Text d4p1:nil="false">ValueHere</Text>
                <!--These fields are applicable if the derived type attribute is set to ImageAsset-->
                <CropHeight d4p1:nil="false">ValueHere</CropHeight>
                <CropWidth d4p1:nil="false">ValueHere</CropWidth>
                <CropX d4p1:nil="false">ValueHere</CropX>
                <CropY d4p1:nil="false">ValueHere</CropY>
                <SubType d4p1:nil="false">ValueHere</SubType>
                <TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
                <TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
                <!--These fields are applicable if the derived type attribute is set to VideoAsset-->
                <SubType d4p1:nil="false">ValueHere</SubType>
                <ThumbnailImage d4p1:nil="false">
                  <CropHeight d4p1:nil="false">ValueHere</CropHeight>
                  <CropWidth d4p1:nil="false">ValueHere</CropWidth>
                  <CropX d4p1:nil="false">ValueHere</CropX>
                  <CropY d4p1:nil="false">ValueHere</CropY>
                  <SubType d4p1:nil="false">ValueHere</SubType>
                  <TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
                  <TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
                </ThumbnailImage>
              </Asset>
              <AssetPerformanceLabel d4p1:nil="false">ValueHere</AssetPerformanceLabel>
              <EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
              <PinnedField d4p1:nil="false">ValueHere</PinnedField>
            </AssetLink>
          </Images>
          <ImpressionTrackingUrls d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a1:string>ValueHere</a1:string>
          </ImpressionTrackingUrls>
          <LongHeadline d4p1:nil="false">
            <Asset d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
              <Id d4p1:nil="false">ValueHere</Id>
              <Name d4p1:nil="false">ValueHere</Name>
              <Type d4p1:nil="false">ValueHere</Type>
              <!--This field is applicable if the derived type attribute is set to TextAsset-->
              <Text d4p1:nil="false">ValueHere</Text>
              <!--These fields are applicable if the derived type attribute is set to ImageAsset-->
              <CropHeight d4p1:nil="false">ValueHere</CropHeight>
              <CropWidth d4p1:nil="false">ValueHere</CropWidth>
              <CropX d4p1:nil="false">ValueHere</CropX>
              <CropY d4p1:nil="false">ValueHere</CropY>
              <SubType d4p1:nil="false">ValueHere</SubType>
              <TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
              <TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
              <!--These fields are applicable if the derived type attribute is set to VideoAsset-->
              <SubType d4p1:nil="false">ValueHere</SubType>
              <ThumbnailImage d4p1:nil="false">
                <CropHeight d4p1:nil="false">ValueHere</CropHeight>
                <CropWidth d4p1:nil="false">ValueHere</CropWidth>
                <CropX d4p1:nil="false">ValueHere</CropX>
                <CropY d4p1:nil="false">ValueHere</CropY>
                <SubType d4p1:nil="false">ValueHere</SubType>
                <TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
                <TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
              </ThumbnailImage>
            </Asset>
            <AssetPerformanceLabel d4p1:nil="false">ValueHere</AssetPerformanceLabel>
            <EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
            <PinnedField d4p1:nil="false">ValueHere</PinnedField>
          </LongHeadline>
          <LongHeadlineString d4p1:nil="false">ValueHere</LongHeadlineString>
          <LongHeadlines d4p1:nil="false">
            <AssetLink>
              <Asset d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
                <Id d4p1:nil="false">ValueHere</Id>
                <Name d4p1:nil="false">ValueHere</Name>
                <Type d4p1:nil="false">ValueHere</Type>
                <!--This field is applicable if the derived type attribute is set to TextAsset-->
                <Text d4p1:nil="false">ValueHere</Text>
                <!--These fields are applicable if the derived type attribute is set to ImageAsset-->
                <CropHeight d4p1:nil="false">ValueHere</CropHeight>
                <CropWidth d4p1:nil="false">ValueHere</CropWidth>
                <CropX d4p1:nil="false">ValueHere</CropX>
                <CropY d4p1:nil="false">ValueHere</CropY>
                <SubType d4p1:nil="false">ValueHere</SubType>
                <TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
                <TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
                <!--These fields are applicable if the derived type attribute is set to VideoAsset-->
                <SubType d4p1:nil="false">ValueHere</SubType>
                <ThumbnailImage d4p1:nil="false">
                  <CropHeight d4p1:nil="false">ValueHere</CropHeight>
                  <CropWidth d4p1:nil="false">ValueHere</CropWidth>
                  <CropX d4p1:nil="false">ValueHere</CropX>
                  <CropY d4p1:nil="false">ValueHere</CropY>
                  <SubType d4p1:nil="false">ValueHere</SubType>
                  <TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
                  <TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
                </ThumbnailImage>
              </Asset>
              <AssetPerformanceLabel d4p1:nil="false">ValueHere</AssetPerformanceLabel>
              <EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
              <PinnedField d4p1:nil="false">ValueHere</PinnedField>
            </AssetLink>
          </LongHeadlines>
          <Text d4p1:nil="false">ValueHere</Text>
          <VerifiedTrackingSettings d4p1:nil="false">
            <Details xmlns:e238="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
              <e238:ArrayOfKeyValuePairOfstringstring>
                <e238:KeyValuePairOfstringstring>
                  <e238:key d4p1:nil="false">ValueHere</e238:key>
                  <e238:value d4p1:nil="false">ValueHere</e238:value>
                </e238:KeyValuePairOfstringstring>
              </e238:ArrayOfKeyValuePairOfstringstring>
            </Details>
          </VerifiedTrackingSettings>
          <Videos d4p1:nil="false">
            <AssetLink>
              <Asset d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
                <Id d4p1:nil="false">ValueHere</Id>
                <Name d4p1:nil="false">ValueHere</Name>
                <Type d4p1:nil="false">ValueHere</Type>
                <!--This field is applicable if the derived type attribute is set to TextAsset-->
                <Text d4p1:nil="false">ValueHere</Text>
                <!--These fields are applicable if the derived type attribute is set to ImageAsset-->
                <CropHeight d4p1:nil="false">ValueHere</CropHeight>
                <CropWidth d4p1:nil="false">ValueHere</CropWidth>
                <CropX d4p1:nil="false">ValueHere</CropX>
                <CropY d4p1:nil="false">ValueHere</CropY>
                <SubType d4p1:nil="false">ValueHere</SubType>
                <TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
                <TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
                <!--These fields are applicable if the derived type attribute is set to VideoAsset-->
                <SubType d4p1:nil="false">ValueHere</SubType>
                <ThumbnailImage d4p1:nil="false">
                  <CropHeight d4p1:nil="false">ValueHere</CropHeight>
                  <CropWidth d4p1:nil="false">ValueHere</CropWidth>
                  <CropX d4p1:nil="false">ValueHere</CropX>
                  <CropY d4p1:nil="false">ValueHere</CropY>
                  <SubType d4p1:nil="false">ValueHere</SubType>
                  <TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
                  <TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
                </ThumbnailImage>
              </Asset>
              <AssetPerformanceLabel d4p1:nil="false">ValueHere</AssetPerformanceLabel>
              <EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
              <PinnedField d4p1:nil="false">ValueHere</PinnedField>
            </AssetLink>
          </Videos>
          <!--These fields are applicable if the derived type attribute is set to ResponsiveSearchAd-->
          <Descriptions d4p1:nil="false">
            <AssetLink>
              <Asset d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
                <Id d4p1:nil="false">ValueHere</Id>
                <Name d4p1:nil="false">ValueHere</Name>
                <Type d4p1:nil="false">ValueHere</Type>
                <!--This field is applicable if the derived type attribute is set to TextAsset-->
                <Text d4p1:nil="false">ValueHere</Text>
                <!--These fields are applicable if the derived type attribute is set to ImageAsset-->
                <CropHeight d4p1:nil="false">ValueHere</CropHeight>
                <CropWidth d4p1:nil="false">ValueHere</CropWidth>
                <CropX d4p1:nil="false">ValueHere</CropX>
                <CropY d4p1:nil="false">ValueHere</CropY>
                <SubType d4p1:nil="false">ValueHere</SubType>
                <TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
                <TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
                <!--These fields are applicable if the derived type attribute is set to VideoAsset-->
                <SubType d4p1:nil="false">ValueHere</SubType>
                <ThumbnailImage d4p1:nil="false">
                  <CropHeight d4p1:nil="false">ValueHere</CropHeight>
                  <CropWidth d4p1:nil="false">ValueHere</CropWidth>
                  <CropX d4p1:nil="false">ValueHere</CropX>
                  <CropY d4p1:nil="false">ValueHere</CropY>
                  <SubType d4p1:nil="false">ValueHere</SubType>
                  <TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
                  <TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
                </ThumbnailImage>
              </Asset>
              <AssetPerformanceLabel d4p1:nil="false">ValueHere</AssetPerformanceLabel>
              <EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
              <PinnedField d4p1:nil="false">ValueHere</PinnedField>
            </AssetLink>
          </Descriptions>
          <Domain d4p1:nil="false">ValueHere</Domain>
          <Headlines d4p1:nil="false">
            <AssetLink>
              <Asset d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
                <Id d4p1:nil="false">ValueHere</Id>
                <Name d4p1:nil="false">ValueHere</Name>
                <Type d4p1:nil="false">ValueHere</Type>
                <!--This field is applicable if the derived type attribute is set to TextAsset-->
                <Text d4p1:nil="false">ValueHere</Text>
                <!--These fields are applicable if the derived type attribute is set to ImageAsset-->
                <CropHeight d4p1:nil="false">ValueHere</CropHeight>
                <CropWidth d4p1:nil="false">ValueHere</CropWidth>
                <CropX d4p1:nil="false">ValueHere</CropX>
                <CropY d4p1:nil="false">ValueHere</CropY>
                <SubType d4p1:nil="false">ValueHere</SubType>
                <TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
                <TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
                <!--These fields are applicable if the derived type attribute is set to VideoAsset-->
                <SubType d4p1:nil="false">ValueHere</SubType>
                <ThumbnailImage d4p1:nil="false">
                  <CropHeight d4p1:nil="false">ValueHere</CropHeight>
                  <CropWidth d4p1:nil="false">ValueHere</CropWidth>
                  <CropX d4p1:nil="false">ValueHere</CropX>
                  <CropY d4p1:nil="false">ValueHere</CropY>
                  <SubType d4p1:nil="false">ValueHere</SubType>
                  <TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
                  <TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
                </ThumbnailImage>
              </Asset>
              <AssetPerformanceLabel d4p1:nil="false">ValueHere</AssetPerformanceLabel>
              <EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
              <PinnedField d4p1:nil="false">ValueHere</PinnedField>
            </AssetLink>
          </Headlines>
          <Path1 d4p1:nil="false">ValueHere</Path1>
          <Path2 d4p1:nil="false">ValueHere</Path2>
        </Ad>
      </Ads>
    </GetAdsByEditorialStatusResponse>
  </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<GetAdsByEditorialStatusResponse> GetAdsByEditorialStatusAsync(
	long adGroupId,
	AdEditorialStatus editorialStatus,
	IList<AdType> adTypes,
	AdAdditionalField? returnAdditionalFields)
{
	var request = new GetAdsByEditorialStatusRequest
	{
		AdGroupId = adGroupId,
		EditorialStatus = editorialStatus,
		AdTypes = adTypes,
		ReturnAdditionalFields = returnAdditionalFields
	};

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

static GetAdsByEditorialStatusResponse getAdsByEditorialStatus(
	java.lang.Long adGroupId,
	AdEditorialStatus editorialStatus,
	ArrayOfAdType adTypes,
	ArrayList<AdAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	GetAdsByEditorialStatusRequest request = new GetAdsByEditorialStatusRequest();

	request.setAdGroupId(adGroupId);
	request.setEditorialStatus(editorialStatus);
	request.setAdTypes(adTypes);
	request.setReturnAdditionalFields(returnAdditionalFields);

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

static function GetAdsByEditorialStatus(
	$adGroupId,
	$editorialStatus,
	$adTypes,
	$returnAdditionalFields)
{

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

	$request = new GetAdsByEditorialStatusRequest();

	$request->AdGroupId = $adGroupId;
	$request->EditorialStatus = $editorialStatus;
	$request->AdTypes = $adTypes;
	$request->ReturnAdditionalFields = $returnAdditionalFields;

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

response=campaignmanagement_service.GetAdsByEditorialStatus(
	AdGroupId=AdGroupId,
	EditorialStatus=EditorialStatus,
	AdTypes=AdTypes,
	ReturnAdditionalFields=ReturnAdditionalFields)

Requirements

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

https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/Ads/QueryByEditorialStatus

https://campaign.api.sandbox.bingads.microsoft.com/CampaignManagement/v13/Ads/QueryByEditorialStatus

Request Elements

The GetAdsByEditorialStatusRequest object defines the body and header elements of the service operation request.

Note

Unless otherwise noted below, all request elements are required.

Request Body Elements

Element	Description	Data Type
AdGroupId	The identifier of the ad group to retrieve the ads from.	long
AdTypes	One or more types of ads to return.	AdType array
EditorialStatus	The editorial review status that the ads must have to be returned.	AdEditorialStatus
ReturnAdditionalFields	The additional field values enable you to get the latest features using the current version of Campaign Management API, and in the next version the corresponding elements will be included by default. This request element is optional.	AdAdditionalField

Request Header Elements

Element	Description	Data Type
Authorization	The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. Please ensure that the token is prefixed with "Bearer ", this is necessary for proper authentication. For more information see Authentication with OAuth.	string
CustomerAccountId	The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs.	string
CustomerId	The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs.	string
DeveloperToken	The developer token used to access the Bing Ads API. For more information see Get a Developer Token.	string
Password	This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials.	string
UserName	This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials.	string

Response Elements

The GetAdsByEditorialStatusResponse 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 JSON.

Response Body Elements

Element	Description	Data Type
Ads	The list of ads that have been retrieved. If the ad group doesn't contain ads that meet the criteria, this array is empty.	Ad array

Response Header Elements

Element	Description	Data Type
TrackingId	The identifier of the log entry that contains the details of the API call.	string

Request JSON

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

{
  "AdGroupId": "LongValueHere",
  "EditorialStatus": "ValueHere",
  "AdTypes": [
    "ValueHere"
  ],
  "ReturnAdditionalFields": "ValueHere"
}

Response JSON

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

Below is an example that is applicable if the type of Ad is AppInstallAd.

{
  "Ads": [
    {
      "AdFormatPreference": "ValueHere",
      "DevicePreference": "LongValueHere",
      "EditorialStatus": "ValueHere",
      "FinalAppUrls": [
        {
          "OsType": "ValueHere",
          "Url": "ValueHere"
        }
      ],
      "FinalMobileUrls": [
        "ValueHere"
      ],
      "FinalUrls": [
        "ValueHere"
      ],
      "FinalUrlSuffix": "ValueHere",
      "ForwardCompatibilityMap": [
        {
          "key": "ValueHere",
          "value": "ValueHere"
        }
      ],
      "Id": "LongValueHere",
      "Status": "ValueHere",
      "TrackingUrlTemplate": "ValueHere",
      "Type": "AppInstall",
      "UrlCustomParameters": {
        "Parameters": [
          {
            "Key": "ValueHere",
            "Value": "ValueHere"
          }
        ]
      },
      "AppPlatform": "ValueHere",
      "AppStoreId": "ValueHere",
      "Text": "ValueHere",
      "Title": "ValueHere"
    }
  ]
}

Code Syntax

To call REST API through SDKs, you need to upgrade SDK to a certain version and configure the system parameters.The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.

public async Task<GetAdsByEditorialStatusResponse> GetAdsByEditorialStatusAsync(
	long adGroupId,
	AdEditorialStatus editorialStatus,
	IList<AdType> adTypes,
	AdAdditionalField? returnAdditionalFields)
{
	var request = new GetAdsByEditorialStatusRequest
	{
		AdGroupId = adGroupId,
		EditorialStatus = editorialStatus,
		AdTypes = adTypes,
		ReturnAdditionalFields = returnAdditionalFields
	};

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

static GetAdsByEditorialStatusResponse getAdsByEditorialStatus(
	java.lang.Long adGroupId,
	AdEditorialStatus editorialStatus,
	ArrayOfAdType adTypes,
	ArrayList<AdAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	GetAdsByEditorialStatusRequest request = new GetAdsByEditorialStatusRequest();

	request.setAdGroupId(adGroupId);
	request.setEditorialStatus(editorialStatus);
	request.setAdTypes(adTypes);
	request.setReturnAdditionalFields(returnAdditionalFields);

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

static function GetAdsByEditorialStatus(
	$adGroupId,
	$editorialStatus,
	$adTypes,
	$returnAdditionalFields)
{

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

	$request = new GetAdsByEditorialStatusRequest();

	$request->AdGroupId = $adGroupId;
	$request->EditorialStatus = $editorialStatus;
	$request->AdTypes = $adTypes;
	$request->ReturnAdditionalFields = $returnAdditionalFields;

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

response=campaignmanagement_service.GetAdsByEditorialStatus(
	AdGroupId=AdGroupId,
	EditorialStatus=EditorialStatus,
	AdTypes=AdTypes,
	ReturnAdditionalFields=ReturnAdditionalFields)

Поделиться через

GetAdsByEditorialStatus Service Operation - Campaign Management

Request Elements

Request Body Elements

Request Header Elements

Response Elements

Response Body Elements

Response Header Elements

Request SOAP

Response SOAP

Code Syntax

Requirements

Request Url

Request Elements

Request Body Elements

Request Header Elements

Response Elements

Response Body Elements

Response Header Elements

Request JSON

Response JSON

Code Syntax

Обратная связь

Дополнительные ресурсы