การดําเนินการบริการ GetAdGroupsByIds - การจัดการแคมเปญ

รับกลุ่มโฆษณาที่ระบุภายในแคมเปญที่ระบุ

ร้องขอองค์ประกอบ

วัตถุ GetAdGroupsByIdsRequest จะกําหนดองค์ประกอบ เนื้อความ และ ส่วนหัว ของการร้องขอการดําเนินการบริการ องค์ประกอบต้องอยู่ในลําดับเดียวกับที่แสดงใน Request SOAP

หมายเหตุ

เว้นแต่ระบุไว้เป็นอย่างอื่นด้านล่าง จําเป็นต้องระบุองค์ประกอบคําขอทั้งหมด

ร้องขอองค์ประกอบเนื้อความ

องค์ ประกอบ	คำอธิบาย	ชนิดข้อมูล
AdGroupIds	มีตัวระบุกลุ่มโฆษณาเพื่อรับได้สูงสุด 1,000 ตัว	อาร์เรย์ยาว
รหัสการส่งเสริมการขาย	ตัวระบุแคมเปญที่ประกอบด้วยกลุ่มโฆษณาที่จะรับ	ยาว
ReturnAdditionalFields	รายการคุณสมบัติเพิ่มเติมที่คุณต้องการรวมไว้ภายในกลุ่มโฆษณาที่ส่งคืนแต่ละกลุ่ม ค่าเขตข้อมูลเพิ่มเติมช่วยให้คุณสามารถรับคุณลักษณะล่าสุดโดยใช้ API การจัดการแคมเปญเวอร์ชันปัจจุบัน และในเวอร์ชันถัดไป องค์ประกอบที่สอดคล้องกันจะถูกรวมไว้ตามค่าเริ่มต้น องค์ประกอบการร้องขอนี้เป็นทางเลือก	AdGroupAdditionalField

องค์ประกอบส่วนหัวของคําขอ

องค์ ประกอบ	คำอธิบาย	ชนิดข้อมูล
AuthenticationToken	โทเค็นการเข้าถึง OAuth ที่แสดงข้อมูลประจําตัวของผู้ใช้ที่มีสิทธิ์เข้าถึงบัญชี Microsoft Advertising สําหรับข้อมูลเพิ่มเติม ดูการรับรองความถูกต้องด้วย OAuth	สาย อักขระ
CustomerAccountId	ตัวระบุบัญชีโฆษณาที่เป็นเจ้าของหรือเชื่อมโยงกับเอนทิตีในคําขอ องค์ประกอบส่วนหัวนี้ต้องมีค่าเดียวกันกับองค์ประกอบเนื้อความ AccountId เมื่อต้องการทั้งสองอย่าง องค์ประกอบนี้จําเป็นสําหรับการดําเนินการบริการส่วนใหญ่ และเป็นแนวทางปฏิบัติที่ดีที่สุดที่คุณควรตั้งค่าไว้เสมอ สําหรับข้อมูลเพิ่มเติม ดูรับบัญชีและรหัสลูกค้าของคุณ	สาย อักขระ
CustomerId	ตัวระบุบัญชีผู้จัดการ (ลูกค้า) ที่ผู้ใช้กําลังเข้าถึงหรือดําเนินการ ผู้ใช้สามารถเข้าถึงบัญชีผู้จัดการได้หลายบัญชี องค์ประกอบนี้จําเป็นสําหรับการดําเนินการบริการส่วนใหญ่ และเป็นแนวทางปฏิบัติที่ดีที่สุดที่คุณควรตั้งค่าไว้เสมอ สําหรับข้อมูลเพิ่มเติม ดูรับบัญชีและรหัสลูกค้าของคุณ	สาย อักขระ
DeveloperToken	โทเค็นนักพัฒนาที่ใช้เพื่อเข้าถึง Bing Ads API สําหรับข้อมูลเพิ่มเติม ดูรับโทเค็นนักพัฒนา	สาย อักขระ
รหัส ผ่าน	องค์ประกอบนี้สงวนไว้สําหรับการใช้ภายในและจะถูกเอาออกจากเวอร์ชันในอนาคตของ API คุณต้องใช้องค์ประกอบ AuthenticationToken เพื่อตั้งค่าข้อมูลประจําตัวของผู้ใช้	สาย อักขระ
ชื่อ	องค์ประกอบนี้สงวนไว้สําหรับการใช้ภายในและจะถูกเอาออกจากเวอร์ชันในอนาคตของ API คุณต้องใช้องค์ประกอบ AuthenticationToken เพื่อตั้งค่าข้อมูลประจําตัวของผู้ใช้	สาย อักขระ

องค์ประกอบการตอบสนอง

วัตถุ GetAdGroupsByIdsResponse จะกําหนดองค์ประกอบ เนื้อความ และ ส่วนหัว ของการตอบสนองการดําเนินการบริการ องค์ประกอบจะถูกส่งกลับตามลําดับเดียวกับที่แสดงใน Response SOAP

องค์ประกอบเนื้อความการตอบสนอง

องค์ ประกอบ	คำอธิบาย	ชนิดข้อมูล
AdGroups	รายการกลุ่มโฆษณาที่สอดคล้องกับตัวระบุกลุ่มโฆษณาที่คุณระบุไว้ในคําขอโดยตรง ข้อมูลในรายการอาจถูกส่งกลับเป็น Null สําหรับแต่ละดัชนีรายการที่ไม่มีการเรียกใช้กลุ่มโฆษณา องค์ประกอบที่สอดคล้องกันจะเป็น Null	อาร์เรย์ AdGroup
ตัวแก้ไขบางส่วน	รายการของข้อผิดพลาดชุดงานที่ประกอบด้วยรายละเอียดสําหรับรายการคําขอใดๆ ที่ไม่ประสบความสําเร็จ รายการของข้อผิดพลาดไม่สอดคล้องกับรายการของหน่วยข้อมูลในคําขอโดยตรง รายการอาจว่างเปล่าถ้าไม่มีข้อผิดพลาด หรืออาจรวมวัตถุข้อผิดพลาดอย่างน้อยหนึ่งวัตถุที่สอดคล้องกับข้อมูลในรายการที่ไม่สําเร็จแต่ละรายการในการร้องขอ	อาร์เรย์ BatchError

องค์ประกอบส่วนหัวการตอบสนอง

องค์ ประกอบ	คำอธิบาย	ชนิดข้อมูล
TrackingId	ตัวระบุของรายการบันทึกที่ประกอบด้วยรายละเอียดของการเรียกใช้ API	สาย อักขระ

ร้องขอ SOAP

เทมเพลตนี้ถูกสร้างขึ้นโดยเครื่องมือเพื่อแสดง ลําดับ ขององค์ประกอบ เนื้อความ และ ส่วนหัว สําหรับคําขอ SOAP สําหรับชนิดที่สนับสนุนที่คุณสามารถใช้กับการดําเนินการบริการนี้ โปรดดูการอ้างอิง องค์ประกอบเนื้อความคําขอ ด้านบน

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

Response SOAP

เทมเพลตนี้ถูกสร้างขึ้นโดยเครื่องมือเพื่อแสดงลําดับขององค์ประกอบ เนื้อ ความและ ส่วนหัว สําหรับการตอบสนอง SOAP

<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>
    <GetAdGroupsByIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <AdGroups d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <AdGroup>
          <AdRotation d4p1:nil="false">
            <EndDate d4p1:nil="false">ValueHere</EndDate>
            <StartDate d4p1:nil="false">ValueHere</StartDate>
            <Type d4p1:nil="false">ValueHere</Type>
          </AdRotation>
          <AudienceAdsBidAdjustment d4p1:nil="false">ValueHere</AudienceAdsBidAdjustment>
          <BiddingScheme d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
            <Type d4p1:nil="false">ValueHere</Type>
            <!--This field is applicable if the derived type attribute is set to MaxClicksBiddingScheme-->
            <MaxCpc d4p1:nil="false">
              <Amount d4p1:nil="false">ValueHere</Amount>
            </MaxCpc>
            <!--These fields are applicable if the derived type attribute is set to MaxConversionsBiddingScheme-->
            <MaxCpc d4p1:nil="false">
              <Amount d4p1:nil="false">ValueHere</Amount>
            </MaxCpc>
            <TargetCpa d4p1:nil="false">ValueHere</TargetCpa>
            <!--These fields are applicable if the derived type attribute is set to TargetCpaBiddingScheme-->
            <MaxCpc d4p1:nil="false">
              <Amount d4p1:nil="false">ValueHere</Amount>
            </MaxCpc>
            <TargetCpa d4p1:nil="false">ValueHere</TargetCpa>
            <!--No additional fields are applicable if the derived type attribute is set to ManualCpcBiddingScheme-->
            <!--No additional fields are applicable if the derived type attribute is set to EnhancedCpcBiddingScheme-->
            <!--No additional fields are applicable if the derived type attribute is set to ManualCpvBiddingScheme-->
            <!--No additional fields are applicable if the derived type attribute is set to ManualCpmBiddingScheme-->
            <!--This field is applicable if the derived type attribute is set to InheritFromParentBiddingScheme-->
            <InheritedBidStrategyType d4p1:nil="false">ValueHere</InheritedBidStrategyType>
            <!--These fields are applicable if the derived type attribute is set to TargetRoasBiddingScheme-->
            <MaxCpc d4p1:nil="false">
              <Amount d4p1:nil="false">ValueHere</Amount>
            </MaxCpc>
            <TargetRoas d4p1:nil="false">ValueHere</TargetRoas>
            <!--This field is applicable if the derived type attribute is set to MaxRoasBiddingScheme-->
            <MaxCpc d4p1:nil="false">
              <Amount d4p1:nil="false">ValueHere</Amount>
            </MaxCpc>
            <!--This field is applicable if the derived type attribute is set to MaxConversionValueBiddingScheme-->
            <TargetRoas d4p1:nil="false">ValueHere</TargetRoas>
            <!--These fields are applicable if the derived type attribute is set to TargetImpressionShareBiddingScheme-->
            <MaxCpc d4p1:nil="false">
              <Amount d4p1:nil="false">ValueHere</Amount>
            </MaxCpc>
            <TargetAdPosition d4p1:nil="false">ValueHere</TargetAdPosition>
            <TargetImpressionShare d4p1:nil="false">ValueHere</TargetImpressionShare>
            <!--This field is applicable if the derived type attribute is set to PercentCpcBiddingScheme-->
            <MaxPercentCpc d4p1:nil="false">ValueHere</MaxPercentCpc>
            <!--This field is applicable if the derived type attribute is set to CommissionBiddingScheme-->
            <CommissionRate d4p1:nil="false">ValueHere</CommissionRate>
            <!--This field is applicable if the derived type attribute is set to ManualCpaBiddingScheme-->
            <ManualCpi d4p1:nil="false">ValueHere</ManualCpi>
            <!--This field is applicable if the derived type attribute is set to CostPerSaleBiddingScheme-->
            <TargetCostPerSale d4p1:nil="false">ValueHere</TargetCostPerSale>
          </BiddingScheme>
          <CommissionRate d4p1:nil="false">
            <RateAmount d4p1:nil="false">
              <Amount d4p1:nil="false">ValueHere</Amount>
            </RateAmount>
          </CommissionRate>
          <CpcBid d4p1:nil="false">
            <Amount d4p1:nil="false">ValueHere</Amount>
          </CpcBid>
          <EndDate d4p1:nil="false">
            <Day>ValueHere</Day>
            <Month>ValueHere</Month>
            <Year>ValueHere</Year>
          </EndDate>
          <FinalUrlSuffix d4p1:nil="false">ValueHere</FinalUrlSuffix>
          <ForwardCompatibilityMap xmlns:e108="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e108:KeyValuePairOfstringstring>
              <e108:key d4p1:nil="false">ValueHere</e108:key>
              <e108:value d4p1:nil="false">ValueHere</e108:value>
            </e108:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <FrequencyCapSettings d4p1:nil="false">
            <FrequencyCapSettings>
              <CapValue>ValueHere</CapValue>
              <TimeGranularity>ValueHere</TimeGranularity>
            </FrequencyCapSettings>
          </FrequencyCapSettings>
          <Id d4p1:nil="false">ValueHere</Id>
          <Language d4p1:nil="false">ValueHere</Language>
          <MultimediaAdsBidAdjustment d4p1:nil="false">ValueHere</MultimediaAdsBidAdjustment>
          <Name d4p1:nil="false">ValueHere</Name>
          <Network d4p1:nil="false">ValueHere</Network>
          <PercentCpcBid d4p1:nil="false">
            <RateAmount d4p1:nil="false">
              <Amount d4p1:nil="false">ValueHere</Amount>
            </RateAmount>
          </PercentCpcBid>
          <PrivacyStatus d4p1:nil="false">ValueHere</PrivacyStatus>
          <Settings d4p1:nil="false">
            <Setting d4p1:type="-- derived type specified here with the appropriate prefix --">
              <Type d4p1:nil="false">ValueHere</Type>
              <!--This field is applicable if the derived type attribute is set to VerifiedTrackingSetting-->
              <Details xmlns:e109="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
                <e109:ArrayOfKeyValuePairOfstringstring>
                  <e109:KeyValuePairOfstringstring>
                    <e109:key d4p1:nil="false">ValueHere</e109:key>
                    <e109:value d4p1:nil="false">ValueHere</e109:value>
                  </e109:KeyValuePairOfstringstring>
                </e109:ArrayOfKeyValuePairOfstringstring>
              </Details>
              <!--These fields are applicable if the derived type attribute is set to ShoppingSetting-->
              <FeedLabel d4p1:nil="false">ValueHere</FeedLabel>
              <LocalInventoryAdsEnabled d4p1:nil="false">ValueHere</LocalInventoryAdsEnabled>
              <Priority d4p1:nil="false">ValueHere</Priority>
              <SalesCountryCode d4p1:nil="false">ValueHere</SalesCountryCode>
              <ShoppableAdsEnabled d4p1:nil="false">ValueHere</ShoppableAdsEnabled>
              <StoreId d4p1:nil="false">ValueHere</StoreId>
              <!--This field is applicable if the derived type attribute is set to DynamicFeedSetting-->
              <FeedId d4p1:nil="false">ValueHere</FeedId>
              <!--These fields are applicable if the derived type attribute is set to DynamicSearchAdsSetting-->
              <DomainName d4p1:nil="false">ValueHere</DomainName>
              <DynamicDescriptionEnabled d4p1:nil="false">ValueHere</DynamicDescriptionEnabled>
              <Language d4p1:nil="false">ValueHere</Language>
              <PageFeedIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <a1:long>ValueHere</a1:long>
              </PageFeedIds>
              <Source d4p1:nil="false">ValueHere</Source>
              <!--This field is applicable if the derived type attribute is set to TargetSetting-->
              <Details d4p1:nil="false">
                <TargetSettingDetail>
                  <CriterionTypeGroup>ValueHere</CriterionTypeGroup>
                  <TargetAndBid>ValueHere</TargetAndBid>
                </TargetSettingDetail>
              </Details>
              <!--These fields are applicable if the derived type attribute is set to CoOpSetting-->
              <BidBoostValue d4p1:nil="false">ValueHere</BidBoostValue>
              <BidMaxValue d4p1:nil="false">ValueHere</BidMaxValue>
              <BidOption d4p1:nil="false">ValueHere</BidOption>
              <!--This field is applicable if the derived type attribute is set to DisclaimerSetting-->
              <DisclaimerAdsEnabled>ValueHere</DisclaimerAdsEnabled>
              <!--This field is applicable if the derived type attribute is set to HotelSetting-->
              <HotelAdGroupType>ValueHere</HotelAdGroupType>
              <!--This field is applicable if the derived type attribute is set to ResponsiveSearchAdsSetting-->
              <AutoGeneratedAssetsEnabled d4p1:nil="false">ValueHere</AutoGeneratedAssetsEnabled>
              <!--These fields are applicable if the derived type attribute is set to PerformanceMaxSetting-->
              <AutoGeneratedImageOptOut d4p1:nil="false">ValueHere</AutoGeneratedImageOptOut>
              <AutoGeneratedTextOptOut d4p1:nil="false">ValueHere</AutoGeneratedTextOptOut>
              <CostPerSaleOptOut d4p1:nil="false">ValueHere</CostPerSaleOptOut>
              <FinalUrlExpansionOptOut>ValueHere</FinalUrlExpansionOptOut>
              <PageFeedIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <a1:long>ValueHere</a1:long>
              </PageFeedIds>
              <!--These fields are applicable if the derived type attribute is set to CallToActionSetting-->
              <AutomatedCallToActionOptOut d4p1:nil="false">ValueHere</AutomatedCallToActionOptOut>
              <CallToActionOptOut d4p1:nil="false">ValueHere</CallToActionOptOut>
              <!--These fields are applicable if the derived type attribute is set to VanityPharmaSetting-->
              <DisplayUrlMode d4p1:nil="false">ValueHere</DisplayUrlMode>
              <WebsiteDescription d4p1:nil="false">ValueHere</WebsiteDescription>
              <!--These fields are applicable if the derived type attribute is set to AppSetting-->
              <AppId d4p1:nil="false">ValueHere</AppId>
              <AppStore>ValueHere</AppStore>
            </Setting>
          </Settings>
          <StartDate d4p1:nil="false">
            <Day>ValueHere</Day>
            <Month>ValueHere</Month>
            <Year>ValueHere</Year>
          </StartDate>
          <Status d4p1:nil="false">ValueHere</Status>
          <TrackingUrlTemplate d4p1:nil="false">ValueHere</TrackingUrlTemplate>
          <UrlCustomParameters d4p1:nil="false">
            <Parameters d4p1:nil="false">
              <CustomParameter>
                <Key d4p1:nil="false">ValueHere</Key>
                <Value d4p1:nil="false">ValueHere</Value>
              </CustomParameter>
            </Parameters>
          </UrlCustomParameters>
          <UseOptimizedTargeting d4p1:nil="false">ValueHere</UseOptimizedTargeting>
          <UsePredictiveTargeting d4p1:nil="false">ValueHere</UsePredictiveTargeting>
          <AdScheduleUseSearcherTimeZone d4p1:nil="false">ValueHere</AdScheduleUseSearcherTimeZone>
          <AdGroupType d4p1:nil="false">ValueHere</AdGroupType>
          <CpvBid d4p1:nil="false">
            <Amount d4p1:nil="false">ValueHere</Amount>
          </CpvBid>
          <CpmBid d4p1:nil="false">
            <Amount d4p1:nil="false">ValueHere</Amount>
          </CpmBid>
          <McpaBid d4p1:nil="false">
            <Amount d4p1:nil="false">ValueHere</Amount>
          </McpaBid>
        </AdGroup>
      </AdGroups>
      <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:e110="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e110:KeyValuePairOfstringstring>
              <e110:key d4p1:nil="false">ValueHere</e110:key>
              <e110:value d4p1:nil="false">ValueHere</e110:value>
            </e110: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>
    </GetAdGroupsByIdsResponse>
  </s:Body>
</s:Envelope>

ไวยากรณ์โค้ด

ไวยากรณ์ตัวอย่างสามารถใช้กับ Bing Ads SDKs ได้ ดู ตัวอย่างโค้ด API ของโฆษณา Bing สําหรับตัวอย่างเพิ่มเติม

public async Task<GetAdGroupsByIdsResponse> GetAdGroupsByIdsAsync(
	long campaignId,
	IList<long> adGroupIds,
	AdGroupAdditionalField? returnAdditionalFields)
{
	var request = new GetAdGroupsByIdsRequest
	{
		CampaignId = campaignId,
		AdGroupIds = adGroupIds,
		ReturnAdditionalFields = returnAdditionalFields
	};

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

static GetAdGroupsByIdsResponse getAdGroupsByIds(
	java.lang.Long campaignId,
	ArrayOflong adGroupIds,
	ArrayList<AdGroupAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	GetAdGroupsByIdsRequest request = new GetAdGroupsByIdsRequest();

	request.setCampaignId(campaignId);
	request.setAdGroupIds(adGroupIds);
	request.setReturnAdditionalFields(returnAdditionalFields);

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

static function GetAdGroupsByIds(
	$campaignId,
	$adGroupIds,
	$returnAdditionalFields)
{

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

	$request = new GetAdGroupsByIdsRequest();

	$request->CampaignId = $campaignId;
	$request->AdGroupIds = $adGroupIds;
	$request->ReturnAdditionalFields = $returnAdditionalFields;

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

response=campaignmanagement_service.GetAdGroupsByIds(
	CampaignId=CampaignId,
	AdGroupIds=AdGroupIds,
	ReturnAdditionalFields=ReturnAdditionalFields)

ข้อกําหนด

บริการ: การส่งเสริมการขายการจัดการบริการ.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13