GetKeywordIdeas サービス操作 - Ad Insight

Request 要素

GetKeywordIdeasRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。 要素は、 要求 SOAP に示されている順序と同じ順序である必要があります。

要求本文要素

要求ヘッダー要素

Response 要素

GetKeywordIdeasResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 応答 SOAP に示されている順序と同じ順序で返されます。

応答本文の要素

応答ヘッダー要素

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">GetKeywordIdeas</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>
    <GetKeywordIdeasRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <ExpandIdeas i:nil="false">ValueHere</ExpandIdeas>
      <IdeaAttributes i:nil="false">
        <KeywordIdeaAttribute>ValueHere</KeywordIdeaAttribute>
      </IdeaAttributes>
      <SearchParameters i:nil="false">
        <SearchParameter i:type="-- derived type specified here with the appropriate prefix --">
          <!--This field is applicable if the derived type attribute is set to QuerySearchParameter-->
          <Queries i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a1:string>ValueHere</a1:string>
          </Queries>
          <!--This field is applicable if the derived type attribute is set to UrlSearchParameter-->
          <Url i:nil="false">ValueHere</Url>
          <!--This field is applicable if the derived type attribute is set to CategorySearchParameter-->
          <CategoryId>ValueHere</CategoryId>
          <!--These fields are applicable if the derived type attribute is set to SearchVolumeSearchParameter-->
          <Maximum i:nil="false">ValueHere</Maximum>
          <Minimum i:nil="false">ValueHere</Minimum>
          <!--These fields are applicable if the derived type attribute is set to SuggestedBidSearchParameter-->
          <Maximum i:nil="false">ValueHere</Maximum>
          <Minimum i:nil="false">ValueHere</Minimum>
          <!--These fields are applicable if the derived type attribute is set to IdeaTextSearchParameter-->
          <Excluded i:nil="false">
            <Keyword>
              <Id i:nil="false">ValueHere</Id>
              <MatchType>ValueHere</MatchType>
              <Text i:nil="false">ValueHere</Text>
            </Keyword>
          </Excluded>
          <Included i:nil="false">
            <Keyword>
              <Id i:nil="false">ValueHere</Id>
              <MatchType>ValueHere</MatchType>
              <Text i:nil="false">ValueHere</Text>
            </Keyword>
          </Included>
          <!--This field is applicable if the derived type attribute is set to ExcludeAccountKeywordsSearchParameter-->
          <ExcludeAccountKeywords>ValueHere</ExcludeAccountKeywords>
          <!--These fields are applicable if the derived type attribute is set to ImpressionShareSearchParameter-->
          <Maximum i:nil="false">ValueHere</Maximum>
          <Minimum i:nil="false">ValueHere</Minimum>
          <!--This field is applicable if the derived type attribute is set to LocationSearchParameter-->
          <Locations i:nil="false">
            <LocationCriterion>
              <LocationId>ValueHere</LocationId>
            </LocationCriterion>
          </Locations>
          <!--This field is applicable if the derived type attribute is set to NetworkSearchParameter-->
          <Network i:nil="false">
            <Network>ValueHere</Network>
          </Network>
          <!--This field is applicable if the derived type attribute is set to DeviceSearchParameter-->
          <Device i:nil="false">
            <DeviceName i:nil="false">ValueHere</DeviceName>
          </Device>
          <!--This field is applicable if the derived type attribute is set to LanguageSearchParameter-->
          <Languages i:nil="false">
            <LanguageCriterion>
              <Language i:nil="false">ValueHere</Language>
            </LanguageCriterion>
          </Languages>
          <!--This field is applicable if the derived type attribute is set to CompetitionSearchParameter-->
          <CompetitionLevels i:nil="false">
            <CompetitionLevel>ValueHere</CompetitionLevel>
          </CompetitionLevels>
          <!--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>
        </SearchParameter>
      </SearchParameters>
    </GetKeywordIdeasRequest>
  </s:Body>
</s:Envelope>

応答 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>
    <GetKeywordIdeasResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <KeywordIdeas d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <KeywordIdea>
          <AdGroupId d4p1:nil="false">ValueHere</AdGroupId>
          <AdGroupName d4p1:nil="false">ValueHere</AdGroupName>
          <AdImpressionShare d4p1:nil="false">ValueHere</AdImpressionShare>
          <Competition d4p1:nil="false">ValueHere</Competition>
          <Keyword d4p1:nil="false">ValueHere</Keyword>
          <MonthlySearchCounts d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a1:long>ValueHere</a1:long>
          </MonthlySearchCounts>
          <Relevance d4p1:nil="false">ValueHere</Relevance>
          <Source d4p1:nil="false">ValueHere</Source>
          <SuggestedBid d4p1:nil="false">ValueHere</SuggestedBid>
        </KeywordIdea>
      </KeywordIdeas>
    </GetKeywordIdeasResponse>
  </s:Body>
</s:Envelope>

コード構文

構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。

public async Task<GetKeywordIdeasResponse> GetKeywordIdeasAsync(
	bool? expandIdeas,
	IList<KeywordIdeaAttribute> ideaAttributes,
	IList<SearchParameter> searchParameters)
{
	var request = new GetKeywordIdeasRequest
	{
		ExpandIdeas = expandIdeas,
		IdeaAttributes = ideaAttributes,
		SearchParameters = searchParameters
	};

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

static GetKeywordIdeasResponse getKeywordIdeas(
	boolean expandIdeas,
	ArrayOfKeywordIdeaAttribute ideaAttributes,
	ArrayOfSearchParameter searchParameters) throws RemoteException, Exception
{
	GetKeywordIdeasRequest request = new GetKeywordIdeasRequest();

	request.setExpandIdeas(expandIdeas);
	request.setIdeaAttributes(ideaAttributes);
	request.setSearchParameters(searchParameters);

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

static function GetKeywordIdeas(
	$expandIdeas,
	$ideaAttributes,
	$searchParameters)
{

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

	$request = new GetKeywordIdeasRequest();

	$request->ExpandIdeas = $expandIdeas;
	$request->IdeaAttributes = $ideaAttributes;
	$request->SearchParameters = $searchParameters;

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

response=adinsight_service.GetKeywordIdeas(
	ExpandIdeas=ExpandIdeas,
	IdeaAttributes=IdeaAttributes,
	SearchParameters=SearchParameters)

要件

Service: AdInsightService.svc v13
Namespace: https://bingads.microsoft.com/AdInsight/v13

要求 URL

https://adinsight.api.bingads.microsoft.com/AdInsight/v13/KeywordIdeas/Query

https://adinsight.api.sandbox.bingads.microsoft.com/AdInsight/v13/KeywordIdeas/Query

Request 要素

GetKeywordIdeasRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。

要求本文要素

要求ヘッダー要素

Response 要素

GetKeywordIdeasResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 Response JSON に示されている順序と同じ順序で返されます。

応答本文の要素

応答ヘッダー要素

JSON を要求する

このテンプレートは、JSON 要求の 本文 と ヘッダー 要素を表示するツールによって生成されました。 このサービス操作で使用できるサポートされる型については、上記の 要求本文要素 のリファレンスを参照してください。

{
  "ExpandIdeas": "ValueHere",
  "IdeaAttributes": [
    "ValueHere"
  ],
  "SearchParameters": [
    {
      "Queries": {
        "string": "ValueHere"
      },
      "Url": "ValueHere",
      "CategoryId": "ValueHere",
      "Maximum": [
        "ValueHere",
        "ValueHere",
        "ValueHere"
      ],
      "Minimum": [
        "ValueHere",
        "ValueHere",
        "ValueHere"
      ],
      "Excluded": {
        "Keyword": {
          "Id": "ValueHere",
          "MatchType": "ValueHere",
          "Text": "ValueHere"
        }
      },
      "Included": {
        "Keyword": {
          "Id": "ValueHere",
          "MatchType": "ValueHere",
          "Text": "ValueHere"
        }
      },
      "ExcludeAccountKeywords": "ValueHere",
      "Locations": {
        "LocationCriterion": {
          "LocationId": "ValueHere"
        }
      },
      "Network": {
        "Network": "ValueHere"
      },
      "Device": {
        "DeviceName": "ValueHere"
      },
      "Languages": {
        "LanguageCriterion": {
          "Language": "ValueHere"
        }
      },
      "CompetitionLevels": {
        "CompetitionLevel": "ValueHere"
      },
      "EndDate": {
        "Day": "ValueHere",
        "Month": "ValueHere",
        "Year": "ValueHere"
      },
      "StartDate": {
        "Day": "ValueHere",
        "Month": "ValueHere",
        "Year": "ValueHere"
      }
    }
  ]
}

応答 JSON

このテンプレートは、JSON 応答の 本文 と ヘッダー 要素を表示するツールによって生成されました。

{
  "KeywordIdeas": [
    {
      "AdGroupId": "LongValueHere",
      "AdGroupName": "ValueHere",
      "AdImpressionShare": DoubleValueHere,
      "Competition": "ValueHere",
      "Keyword": "ValueHere",
      "MonthlySearchCounts": [
        "LongValueHere"
      ],
      "Relevance": DoubleValueHere,
      "Source": "ValueHere",
      "SuggestedBid": DoubleValueHere
    }
  ]
}

コード構文

SDK を使用して REST API を呼び出すには、SDK を特定のバージョンにアップグレードし、システム パラメーターを構成する必要があります。構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。

public async Task<GetKeywordIdeasResponse> GetKeywordIdeasAsync(
	bool? expandIdeas,
	IList<KeywordIdeaAttribute> ideaAttributes,
	IList<SearchParameter> searchParameters)
{
	var request = new GetKeywordIdeasRequest
	{
		ExpandIdeas = expandIdeas,
		IdeaAttributes = ideaAttributes,
		SearchParameters = searchParameters
	};

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

static GetKeywordIdeasResponse getKeywordIdeas(
	boolean expandIdeas,
	ArrayOfKeywordIdeaAttribute ideaAttributes,
	ArrayOfSearchParameter searchParameters) throws RemoteException, Exception
{
	GetKeywordIdeasRequest request = new GetKeywordIdeasRequest();

	request.setExpandIdeas(expandIdeas);
	request.setIdeaAttributes(ideaAttributes);
	request.setSearchParameters(searchParameters);

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

static function GetKeywordIdeas(
	$expandIdeas,
	$ideaAttributes,
	$searchParameters)
{

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

	$request = new GetKeywordIdeasRequest();

	$request->ExpandIdeas = $expandIdeas;
	$request->IdeaAttributes = $ideaAttributes;
	$request->SearchParameters = $searchParameters;

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

response=adinsight_service.GetKeywordIdeas(
	ExpandIdeas=ExpandIdeas,
	IdeaAttributes=IdeaAttributes,
	SearchParameters=SearchParameters)