Returns the details of the specified ad group. Specify the ad group identification number for the ad group you want to inspect. The service returns an error if you attempt to retrieve information on an invalid adGroupId (such as an ID for an ad group that has been deleted).
Back to top
|Output Samples Change History|
The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).
See also Samples.
<?xml version="1.0" encoding="utf-8"?> <getAdGroupRequest xmlns="http://www.ebaypartnernetwork.com/adcommerce/v1/services"> <adGroupId> long </adGroupId> </getAdGroupRequest>
|Standard Input Fields [Jump to call-specific fields]|
|Call-specific Input Fields|
|adGroupId||long||Required||Ad group ID number for the group you want to return. The service returns an error if you attempt to retrieve information on an invalid adGroupId (such as an ID for an ad group that has been deleted). Run the getCampaignAdGroups to see a list of the current ad groups and their associated agGroupId numbers.|
Back to top
|Input Samples Change History|
The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).
See also Samples.
<?xml version="1.0" encoding="utf-8"?> <getAdGroupResponse xmlns="http://www.ebaypartnernetwork.com/adcommerce/v1/services"> <!-- Standard Output Fields --> <ack> AckValue </ack> <control> Control <quotaRemaining> int </quotaRemaining> <requestId> string </requestId> <totalProcessedCount> int </totalProcessedCount> <totalSuccessCount> int </totalSuccessCount> </control> <errorMessage> ErrorMessage <error> ErrorData <category> ErrorCategory </category> <domain> string </domain> <errorId> long </errorId> <exceptionId> token </exceptionId> <message> string </message> <parameter name="string"> ErrorParameter (string) </parameter> <!-- ... more parameter nodes here ... --> <severity> ErrorSeverity </severity> <subdomain> string </subdomain> </error> <!-- ... more error nodes here ... --> </errorMessage> <timestamp> dateTime </timestamp> <version> string </version> <!-- Call-specific Output Fields --> <adGroup> AdGroup <adGroupId> long </adGroupId> <defaultMaxCPC> double </defaultMaxCPC> <description> string </description> <name> string </name> <status> token </status> </adGroup> </getAdGroupResponse>
|Standard Output Fields [Show standard output field descriptions]|
Indicates whether or not errors or warnings were generated during the processing of the request.
(out) eBay encountered a fatal error during the processing of the request, causing the request to fail. When a serious application-level error occurs, the error is returned instead of the business data.
(out) eBay successfully processed the request, but one or more non-fatal errors occurred during the processing. For best results, requests should return without warning messages. Inspect the message details and resolve any problems before resubmitting the request.
(out) eBay successfully processed the request and the business data is returned in the response. Note that it is possible for a response to return Success, but still not contain the expected data in the result.
(out) The request was successfully processed, but eBay encountered a non-fatal error during the processing. For best results, requests should return without warnings. Inspect the warning details and resolve the problem before resubmitting the request.
|control||Control||Always||Container for control information.|
|control.quotaRemaining||int||Always||Reserved for future use.|
|control.requestId||string||Always||The unique ID associated with the request. This values is assigned by eBay.|
|control.totalProcessedCount||int||Always||Total number of items processed by the request.|
|control.totalSuccessCount||int||Always||Total number of successfully processed items.|
|errorMessage||ErrorMessage||Conditionally||Information associated an error or warning that occurred when eBay processed the request. Not returned when the ack value is Success. Run-time errors are not reported here, but are instead reported as part of a SOAP fault.|
|Details about a single error.|
There are three categories of errors: request errors, application errors, and system errors.
(out) An error occurred due to a problem with the request, with the most likely source being the application sending the request. For example, the request is missing a required data element or it contains an invalid field. The problem must be corrected before the request can be resent. Inspect the error message to find the cause of the problem. If the problem is due to an application error, modify the application and resend the request. If the error is due to invalid data, the source of the data must be corrected before you resend the resend request to eBay.
(out) An error occurred due to a problem with the request, with the most likely source being missing or invalid data in the request. The problem must be corrected before the request can be retried. Inspect the error message to find the cause of the problem. If the problem is a result of end-user data, alert the end-user to the problem and provide the means for them to correct the problem. Once the problem is resolved, resend the request to eBay.
(out) Indicates that an error has occurred on the eBay system side. For example, a database or server could be down. Inspect the error message to find the cause of the problem. If the problem is on the eBay side, an application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
Name of the domain in which the error occurred.
|errorMessage.error.errorId||long||Conditionally||A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.|
|errorMessage.error.exceptionId||token||Conditionally||Unique identifier for an exception associated with an error.|
|errorMessage.error.message||string||Conditionally||A detailed description of the condition that caused in the error.|
|Various warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error.|
[ attribute name ]
|string||Conditionally||The name of the input parameter returned with the error. Inspecting the parameter (or its input value) will often aid in understanding the cause of the error. Not all error messages contain this value.|
Indicates whether the reported problem is fatal (an error) or is less-severe (a warning). Review the error message details for information on the cause.
If the request fails and the application is the source of the error (for example, a required element is missing), update the application before you retry the request. If the problem is due to incorrect user data, alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, re-send the request to eBay.
If the source of the problem is on eBay's side, you can retry the request a reasonable number of times (eBay recommends you try the request twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, you can resend the request in its original form.
If a warning occurs, warning information is returned in addition to the business data. Normally, you do not need to resend the request (as the original request was successful). However, depending on the cause of the warning, you might need to contact the end user, or eBay, to effect a long term solution to the problem.
(out) eBay encountered a fatal error during the processing of the request, causing the request to fail. When eBay encounters an error, it returns error data instead of the requested business data. Inspect the error details and resolve the problem before resubmitting the request.
(out) The request was successfully processed, but eBay encountered a non-fatal error during the processing that could affect the data returned. For example, eBay might have changed the value of an input field. In this case, eBay returns a successful response, but it also returns a warning. For best results, requests should return without warnings. Inspect the warning details and resolve the problem before resubmitting the request.
|errorMessage.error.subdomain||string||Conditionally||Reserved for future use.|
|timestamp||dateTime||Always||This value represents the date and time when eBay processed the request. The time zone of this value is GMT, and is returned in the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about the time format and for details on converting to and from the GMT time zone.|
|version||string||Always||The release version of the service that eBay used to process the request.|
|Call-specific Output Fields|
|adGroup||AdGroup||Always||Returns the details the on the respective ad group.|
|adGroup.adGroupId||long||Always||Unique identifier for an ad group. This value is assigned by the eBay Partner Network when the ad group is created with the addAdGroup call and is read-only. Use this number to specify the ad group that you want to retrieve, update, or delete.|
|adGroup.defaultMaxCPC||double||Always||User-assigned, default maximum cost per click (CPC) value for all creatives in the ad group. This maximum value applies to any creative in the ad group if a keyword-level maxCPC is not specified.|
User-supplied description for the associated ad group. Use this field to add a detailed description to the ad group. This is in contrast to the name field, which contains a short identifying tag that is used in reports.
Max length: 512.
The short name that you want to give the ad group. The name should be descriptive, but short enough to use in the report tables. Valid ad group names begin with an alpha-numeric character, and can contain up to 50 alpha-numeric characters and spaces.
Max length: 50.
Indicates where the ad group is in AdCommerce processing. Values are:
Back to top
|Input Output Change History|
New to making API calls? Please see Making an API Call.
Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.
Returns the details of the specified ad group (adGroupId).
getAdGroup has a single input parameter, the adGroupId value of the ad group you want to examine. You can review multiple ad groups by repeating the adGroupId element for each ad group you want to inspect. Call getCampaignAdGroups to retrieve information on all the ad groups associated with a specific campaign.
This call is useful when you need to review the details of a specific ad group, or to see if the adGroupId you are using addresses the correct ad group.
The user wants to see the details of an ad group for their Guitar Accessories campaign. The call takes a currently valid adGroupId. The response contains all the details of the respective ad group.
XML format (HTTP POST). Also available is the .txt version of this XML. <getAdGroupRequest xmlns="http://www.ebaypartnernetwork.com/adcommerce/v1/services"> <adGroupId>4513933700</adGroupId> </getAdGroupRequest>
XML format. Also available is the .txt version of this XML. <getAdGroupResponse xmlns:sct="http://www.ebay.com/soaframework/common/types" xmlns="http://www.ebaypartnernetwork.com/adcommerce/v1/services" xmlns:ms="http://www.ebay.com/marketplace/services"> <ack>Success</ack> <errorMessage/> <version>1.0.0</version> <timestamp>2009-05-13T20:15:24.951Z</timestamp> <adGroup> <defaultMaxCPC>0.1</defaultMaxCPC> <description>Max's Guitar Accessories AdGroup</description> <adGroupId>4513933700</adGroupId> <name>guitarAccessories_AdGroup</name> <status>ACTIVE</status> </adGroup> </getAdGroupResponse>
Back to top
|Input Output Samples|
Back to top
|Input Output Samples Change History|
This document was generated with a customized version of the apireferencedocs tool [0.5M zip].
© 2009 eBay, Inc. All rights reserved.