GoogleImportJob Data Object - Campaign Management
Defines a Google import job that can be run once or scheduled on a recurring basis.
Note
- Starting February 1, 2023, you'll no longer be able to import expanded text ads from Google Ads. Any expanded text ads imported before then can be re-imported and we'll continue to import status changes (e.g., pause, unpause) from Google Ads.
- Learn more about this change.
An account can have up to 100 scheduled Google import jobs.
Tip
For an implementation overview, see the Google Ads Import technical guide.
Syntax
<xs:complexType name="GoogleImportJob" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexContent mixed="false">
<xs:extension base="tns:ImportJob">
<xs:sequence>
<xs:element minOccurs="0" name="CampaignAdGroupIds" nillable="true" type="tns:ArrayOfCampaignAdGroupIds" />
<xs:element name="CredentialId" nillable="true" type="xs:string" />
<xs:element name="GoogleAccountId" nillable="true" type="xs:long" />
<xs:element minOccurs="0" name="GoogleUserName" nillable="true" type="xs:string" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Elements
The GoogleImportJob object has the following elements: CampaignAdGroupIds, CredentialId, GoogleAccountId, GoogleUserName.
Element | Description | Data Type |
---|---|---|
CampaignAdGroupIds | The list of campaigns and their ad groups to import from Google Ads. The identifiers are saved but not validated when you create an import job. If you include invalid campaign or ad group IDs, or if they become invalid e.g., the entities are deleted later from Google Ads, the invalid entities will be skipped during import. Add: Optional. If this element is not set, then all of the campaigns and ad groups in the Google Ads account are eligible for import. The set of imported entities also depends on your import options. Update: Optional. If no value is set for the update, this setting is not changed. |
CampaignAdGroupIds array |
CredentialId | Authorizes a Google Ads user to import accounts to Microsoft Advertising. This element is not returned when you get the GoogleImportJob. See the Get an Import Credential ID guide for more details. Add: Required Update: Read-only |
string |
GoogleAccountId | The Google Ads account to import. Add: Required Update: Read-only |
long |
GoogleUserName | The Google account i.e., the Google user credentials with access to the Google Ads account. Add: Read-only Update: Read-only |
string |
The GoogleImportJob object has Inherited Elements.
Inherited Elements
Inherited Elements from ImportJob
The GoogleImportJob object derives from the ImportJob object, and inherits the following elements: CreatedByUserId, CreatedByUserName, CreatedDateTimeInUTC, Frequency, Id, ImportOption, LastRunTimeInUTC, Name, NotificationEmail, NotificationType, Status, Type. The descriptions below are specific to GoogleImportJob, and might not apply to other objects that inherit the same elements from the ImportJob object.
Element | Description | Data Type |
---|---|---|
CreatedByUserId | The unique identifier of the Microsoft Advertising user who created the import job. Add: Read-only Update: Read-only |
long |
CreatedByUserName | The login user name of the Microsoft Advertising user who created the import job. Add: Read-only Update: Read-only |
string |
CreatedDateTimeInUTC | The date and time when the import job was created. The date and time is expressed in Coordinated Universal Time (UTC). Add: Read-only Update: Read-only |
dateTime |
Frequency | Determines whether the import job should be run once or scheduled on a recurring basis. To run the import job now, this element must be nil or empty. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. |
Frequency |
Id | The unique Microsoft Advertising identifier of the import job. Add: Read-only Update: Read-only |
long |
ImportOption | The Google import options that are available via API. To customize Google import options, you can include a GoogleImportOption object. Otherwise to use the default Google import options, you can leave this element nil or empty. For more information about default options, see GoogleImportOption. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. |
ImportOption |
LastRunTimeInUTC | The most recent import date and time for this job. The date and time is expressed in Coordinated Universal Time (UTC). Add: Read-only Update: Read-only |
dateTime |
Name | The name of the import job. The name can be between 1 to 255 characters in length. Add: Required Update: Read-only |
string |
NotificationEmail | The email address where import results should be sent. This element is not returned by default. To get this element, include the NotificationEmail value in the ReturnAdditionalFields element when you call the GetImportJobsByIds and GetImportResults service operations. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. |
string |
NotificationType | Determines whether and how often you want to receive email notifications about the import job results. The supported values are "None" (No emails), "Changes" (Only if there are changes or errors), "Errors" (Only if there are errors), and "EveryTime" (Every time this import runs). Add: Optional. If not set, the service sets this element to "None" by default. Update: Optional. If no value is set for the update, this setting is not changed. |
string |
Status | The status of the import job. The possible values are Active, Pause and Deleted. Scheduled imports will have an Active status, whether the job is scheduled once or on a recurring basis in the future. Paused import jobs will have a Pause status. The status of import jobs that only run once will be set to Deleted after the import. Add: Read-only Update: Optional. If no value is set for the update, this setting is not changed. |
string |
Type | The type of the import job. This value is GoogleImportJob when you retrieve a Google import job. For more information about import job types, see the ImportJob Data Object Remarks. Add: Read-only Update: Read-only |
string |
Requirements
Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13