การดําเนินการบริการ GetAuctionInsightData - ข้อมูลเชิงลึกของโฆษณา

รับข้อมูลเชิงลึกด้านการประมูลสําหรับบัญชี แคมเปญ กลุ่มโฆษณา หรือคีย์เวิร์ด

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

หากนี่เป็นแคมเปญใหม่ หรือหากคุณมีการแสดงผลน้อยเกินไป จะไม่มีการสร้างข้อมูลข้อมูลเชิงลึกของการประมูลขึ้น

ระยะเวลาการเก็บข้อมูลคือ 180 วัน

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

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

หมายเหตุ

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

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

องค์ ประกอบ	คำอธิบาย	ชนิดข้อมูล
EntityIds	ตัวระบุ Microsoft Advertising สําหรับแคมเปญ กลุ่มโฆษณา หรือคีย์เวิร์ดสูงสุด 200 รายการ องค์ประกอบนี้จําเป็นสําหรับแคมเปญ กลุ่มโฆษณา และประเภทเอนทิตีของคีย์เวิร์ด ถ้า EntityType เป็น Account องค์ประกอบนี้เป็นตัวเลือกและจะแทนที่ค่าที่ตั้งค่าในส่วนหัว CustomerAccountId โดยไม่คํานึงถึงชนิดเอนทิตี คุณต้องตั้งค่าองค์ประกอบส่วนหัว CustomerId และ CustomerAccountId	อาร์เรย์ยาว
EntityType	ระดับเอนทิตีที่คุณต้องการร้องขอข้อมูลเชิงลึกการประมูล ค่าที่สนับสนุนคือ บัญชี แคมเปญ AdGroup และคีย์เวิร์ด องค์ประกอบนี้จําเป็นต้องมี	EntityType
ReturnAdditionalFields	รายการคุณสมบัติเพิ่มเติมที่คุณต้องการรวมไว้ภายใน KPI ของข้อมูลเชิงลึกการประมูลผลลัพธ์แต่ละรายการ ค่าเขตข้อมูลเพิ่มเติมช่วยให้คุณสามารถรับคุณลักษณะล่าสุดโดยใช้ API ข้อมูลเชิงลึกของ Ad เวอร์ชันปัจจุบัน และในเวอร์ชันถัดไป องค์ประกอบที่สอดคล้องกันจะถูกรวมไว้ตามค่าเริ่มต้น องค์ประกอบการร้องขอนี้เป็นทางเลือก	AuctionInsightKpiAdditionalField
SearchParameters	พารามิเตอร์การค้นหาจะกําหนดเกณฑ์และตัวกรองของคุณสําหรับข้อมูลข้อมูลเชิงลึกของการประมูล คุณต้องรวม DateRangeSearchParameter หนึ่งตัวเท่านั้น นอกจากนี้ คุณสามารถเลือกรวมออบเจ็กต์ AuctionSegmentSearchParameter ที่แตกต่างกันได้ถึงสามรายการ เช่น สําหรับวัน, DayOfWeek และอุปกรณ์ วัตถุอื่นๆ ที่สืบทอดมาจาก SearchParameter ไม่ถูกต้องสําหรับการดําเนินการนี้	อาร์เรย์ SearchParameter

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

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

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

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

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

องค์ ประกอบ	คำอธิบาย	ชนิดข้อมูล
ผล	รวมถึงรายการข้อมูลเชิงลึกของการประมูลสําหรับเอนทิตีที่ร้องขอ ช่วงวันที่ และพารามิเตอร์การค้นหาเซกเมนต์	AuctionInsightResult

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

องค์ ประกอบ	คำอธิบาย	ชนิดข้อมูล
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/AdInsight/v13">
    <Action mustUnderstand="1">GetAuctionInsightData</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>
    <GetAuctionInsightDataRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <EntityType>ValueHere</EntityType>
      <EntityIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </EntityIds>
      <SearchParameters i:nil="false">
        <SearchParameter i:type="-- derived type specified here with the appropriate prefix --">
          <!--These fields are applicable if the derived type attribute is set to DateRangeSearchParameter-->
          <EndDate i:nil="false">
            <Day>ValueHere</Day>
            <Month>ValueHere</Month>
            <Year>ValueHere</Year>
          </EndDate>
          <StartDate i:nil="false">
            <Day>ValueHere</Day>
            <Month>ValueHere</Month>
            <Year>ValueHere</Year>
          </StartDate>
          <!--This field is applicable if the derived type attribute is set to AuctionSegmentSearchParameter-->
          <Segment>ValueHere</Segment>
        </SearchParameter>
      </SearchParameters>
      <ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
    </GetAuctionInsightDataRequest>
  </s:Body>
</s:Envelope>

Response SOAP

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

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/AdInsight/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <GetAuctionInsightDataResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <Result d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <Segments d4p1:nil="false">
          <AuctionSegment>ValueHere</AuctionSegment>
        </Segments>
        <Entries d4p1:nil="false">
          <AuctionInsightEntry>
            <DisplayDomain d4p1:nil="false">ValueHere</DisplayDomain>
            <AggregatedKpi d4p1:nil="false">
              <Segments d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <a1:string>ValueHere</a1:string>
              </Segments>
              <ImpressionShare>ValueHere</ImpressionShare>
              <OverlapRate>ValueHere</OverlapRate>
              <AveragePosition>ValueHere</AveragePosition>
              <AboveRate>ValueHere</AboveRate>
              <TopOfPageRate>ValueHere</TopOfPageRate>
              <OutrankingShare>ValueHere</OutrankingShare>
              <AbsoluteTopOfPageRate>ValueHere</AbsoluteTopOfPageRate>
            </AggregatedKpi>
            <SegmentedKpis d4p1:nil="false">
              <AuctionInsightKpi>
                <Segments d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <a1:string>ValueHere</a1:string>
                </Segments>
                <ImpressionShare>ValueHere</ImpressionShare>
                <OverlapRate>ValueHere</OverlapRate>
                <AveragePosition>ValueHere</AveragePosition>
                <AboveRate>ValueHere</AboveRate>
                <TopOfPageRate>ValueHere</TopOfPageRate>
                <OutrankingShare>ValueHere</OutrankingShare>
                <AbsoluteTopOfPageRate>ValueHere</AbsoluteTopOfPageRate>
              </AuctionInsightKpi>
            </SegmentedKpis>
          </AuctionInsightEntry>
        </Entries>
        <UsedImpressions>ValueHere</UsedImpressions>
        <UsedKeywords>ValueHere</UsedKeywords>
      </Result>
    </GetAuctionInsightDataResponse>
  </s:Body>
</s:Envelope>

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

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

public async Task<GetAuctionInsightDataResponse> GetAuctionInsightDataAsync(
	EntityType entityType,
	IList<long> entityIds,
	IList<SearchParameter> searchParameters,
	AuctionInsightKpiAdditionalField? returnAdditionalFields)
{
	var request = new GetAuctionInsightDataRequest
	{
		EntityType = entityType,
		EntityIds = entityIds,
		SearchParameters = searchParameters,
		ReturnAdditionalFields = returnAdditionalFields
	};

	return (await AdInsightService.CallAsync((s, r) => s.GetAuctionInsightDataAsync(r), request));
}

static GetAuctionInsightDataResponse getAuctionInsightData(
	EntityType entityType,
	ArrayOflong entityIds,
	ArrayOfSearchParameter searchParameters,
	ArrayList<AuctionInsightKpiAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	GetAuctionInsightDataRequest request = new GetAuctionInsightDataRequest();

	request.setEntityType(entityType);
	request.setEntityIds(entityIds);
	request.setSearchParameters(searchParameters);
	request.setReturnAdditionalFields(returnAdditionalFields);

	return AdInsightService.getService().getAuctionInsightData(request);
}

static function GetAuctionInsightData(
	$entityType,
	$entityIds,
	$searchParameters,
	$returnAdditionalFields)
{

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

	$request = new GetAuctionInsightDataRequest();

	$request->EntityType = $entityType;
	$request->EntityIds = $entityIds;
	$request->SearchParameters = $searchParameters;
	$request->ReturnAdditionalFields = $returnAdditionalFields;

	return $GLOBALS['AdInsightProxy']->GetService()->GetAuctionInsightData($request);
}

response=adinsight_service.GetAuctionInsightData(
	EntityType=EntityType,
	EntityIds=EntityIds,
	SearchParameters=SearchParameters,
	ReturnAdditionalFields=ReturnAdditionalFields)

ข้อกําหนด

บริการ: AdInsightService.svc v13
Namespace: https://bingads.microsoft.com/AdInsight/v13