airbyte 0.7.0-beta2, Mar 7 25

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

airbyte.SourceAppleSearchAds

Explore with Pulumi AI

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.airbyte.SourceAppleSearchAds;
import com.pulumi.airbyte.SourceAppleSearchAdsArgs;
import com.pulumi.airbyte.inputs.SourceAppleSearchAdsConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var mySourceApplesearchads = new SourceAppleSearchAds("mySourceApplesearchads", SourceAppleSearchAdsArgs.builder()
            .configuration(SourceAppleSearchAdsConfigurationArgs.builder()
                .backoff_factor(10)
                .client_id("...my_client_id...")
                .client_secret("...my_client_secret...")
                .end_date("2021-01-01")
                .lookback_window(7)
                .org_id(0)
                .start_date("2020-01-01")
                .build())
            .definitionId("f6eb56d1-0915-427d-b110-58bf43673ee3")
            .secretId("...my_secret_id...")
            .workspaceId("87d57ac5-8ac6-43ff-882e-85cc9f51f076")
            .build());

    }
}

resources:
  mySourceApplesearchads:
    type: airbyte:SourceAppleSearchAds
    properties:
      configuration:
        backoff_factor: 10
        client_id: '...my_client_id...'
        client_secret: '...my_client_secret...'
        end_date: 2021-01-01
        lookback_window: 7
        org_id: 0
        start_date: 2020-01-01
      definitionId: f6eb56d1-0915-427d-b110-58bf43673ee3
      secretId: '...my_secret_id...'
      workspaceId: 87d57ac5-8ac6-43ff-882e-85cc9f51f076

Create SourceAppleSearchAds Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SourceAppleSearchAds(name: string, args: SourceAppleSearchAdsArgs, opts?: CustomResourceOptions);

@overload
def SourceAppleSearchAds(resource_name: str,
                         args: SourceAppleSearchAdsArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def SourceAppleSearchAds(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         configuration: Optional[SourceAppleSearchAdsConfigurationArgs] = None,
                         workspace_id: Optional[str] = None,
                         definition_id: Optional[str] = None,
                         name: Optional[str] = None,
                         secret_id: Optional[str] = None)

func NewSourceAppleSearchAds(ctx *Context, name string, args SourceAppleSearchAdsArgs, opts ...ResourceOption) (*SourceAppleSearchAds, error)

public SourceAppleSearchAds(string name, SourceAppleSearchAdsArgs args, CustomResourceOptions? opts = null)

public SourceAppleSearchAds(String name, SourceAppleSearchAdsArgs args)
public SourceAppleSearchAds(String name, SourceAppleSearchAdsArgs args, CustomResourceOptions options)

type: airbyte:SourceAppleSearchAds
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args SourceAppleSearchAdsArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args SourceAppleSearchAdsArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args SourceAppleSearchAdsArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SourceAppleSearchAdsArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SourceAppleSearchAdsArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var sourceAppleSearchAdsResource = new Airbyte.SourceAppleSearchAds("sourceAppleSearchAdsResource", new()
{
    Configuration = new Airbyte.Inputs.SourceAppleSearchAdsConfigurationArgs
    {
        ClientId = "string",
        ClientSecret = "string",
        OrgId = 0,
        StartDate = "string",
        BackoffFactor = 0,
        EndDate = "string",
        LookbackWindow = 0,
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

example, err := airbyte.NewSourceAppleSearchAds(ctx, "sourceAppleSearchAdsResource", &airbyte.SourceAppleSearchAdsArgs{
Configuration: &.SourceAppleSearchAdsConfigurationArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
OrgId: pulumi.Float64(0),
StartDate: pulumi.String("string"),
BackoffFactor: pulumi.Float64(0),
EndDate: pulumi.String("string"),
LookbackWindow: pulumi.Float64(0),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

var sourceAppleSearchAdsResource = new SourceAppleSearchAds("sourceAppleSearchAdsResource", SourceAppleSearchAdsArgs.builder()
    .configuration(SourceAppleSearchAdsConfigurationArgs.builder()
        .clientId("string")
        .clientSecret("string")
        .orgId(0)
        .startDate("string")
        .backoffFactor(0)
        .endDate("string")
        .lookbackWindow(0)
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

source_apple_search_ads_resource = airbyte.SourceAppleSearchAds("sourceAppleSearchAdsResource",
    configuration={
        "client_id": "string",
        "client_secret": "string",
        "org_id": 0,
        "start_date": "string",
        "backoff_factor": 0,
        "end_date": "string",
        "lookback_window": 0,
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

const sourceAppleSearchAdsResource = new airbyte.SourceAppleSearchAds("sourceAppleSearchAdsResource", {
    configuration: {
        clientId: "string",
        clientSecret: "string",
        orgId: 0,
        startDate: "string",
        backoffFactor: 0,
        endDate: "string",
        lookbackWindow: 0,
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

type: airbyte:SourceAppleSearchAds
properties:
    configuration:
        backoffFactor: 0
        clientId: string
        clientSecret: string
        endDate: string
        lookbackWindow: 0
        orgId: 0
        startDate: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

SourceAppleSearchAds Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SourceAppleSearchAds resource accepts the following input properties:

Configuration SourceAppleSearchAdsConfiguration
WorkspaceId string
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Configuration SourceAppleSearchAdsConfigurationArgs
WorkspaceId string
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceAppleSearchAdsConfiguration
workspaceId String
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceAppleSearchAdsConfiguration
workspaceId string
definitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name string: Name of the source e.g. dev-mysql-instance.
secretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceAppleSearchAdsConfigurationArgs
workspace_id str
definition_id str: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name str: Name of the source e.g. dev-mysql-instance.
secret_id str: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration Property Map
workspaceId String
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Outputs

All input properties are implicitly available as output properties. Additionally, the SourceAppleSearchAds resource produces the following output properties:

CreatedAt double
Id string: The provider-assigned unique ID for this managed resource.
SourceId string
SourceType string

CreatedAt float64
Id string: The provider-assigned unique ID for this managed resource.
SourceId string
SourceType string

createdAt Double
id String: The provider-assigned unique ID for this managed resource.
sourceId String
sourceType String

createdAt number
id string: The provider-assigned unique ID for this managed resource.
sourceId string
sourceType string

created_at float
id str: The provider-assigned unique ID for this managed resource.
source_id str
source_type str

createdAt Number
id String: The provider-assigned unique ID for this managed resource.
sourceId String
sourceType String

Look up Existing SourceAppleSearchAds Resource

Get an existing SourceAppleSearchAds resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SourceAppleSearchAdsState, opts?: CustomResourceOptions): SourceAppleSearchAds

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceAppleSearchAdsConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourceAppleSearchAds

func GetSourceAppleSearchAds(ctx *Context, name string, id IDInput, state *SourceAppleSearchAdsState, opts ...ResourceOption) (*SourceAppleSearchAds, error)

public static SourceAppleSearchAds Get(string name, Input<string> id, SourceAppleSearchAdsState? state, CustomResourceOptions? opts = null)

public static SourceAppleSearchAds get(String name, Output<String> id, SourceAppleSearchAdsState state, CustomResourceOptions options)

resources:  _:    type: airbyte:SourceAppleSearchAds    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Configuration SourceAppleSearchAdsConfiguration
CreatedAt double
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string

Configuration SourceAppleSearchAdsConfigurationArgs
CreatedAt float64
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string

configuration SourceAppleSearchAdsConfiguration
createdAt Double
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

configuration SourceAppleSearchAdsConfiguration
createdAt number
definitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name string: Name of the source e.g. dev-mysql-instance.
secretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId string
sourceType string
workspaceId string

configuration SourceAppleSearchAdsConfigurationArgs
created_at float
definition_id str: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name str: Name of the source e.g. dev-mysql-instance.
secret_id str: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
source_id str
source_type str
workspace_id str

configuration Property Map
createdAt Number
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

Supporting Types

SourceAppleSearchAdsConfiguration, SourceAppleSearchAdsConfigurationArgs

ClientId string: A user identifier for the token request. See \n\nhere\n\n
ClientSecret string: A string that authenticates the user’s setup request. See \n\nhere\n\n
OrgId double: The identifier of the organization that owns the campaign. Your Org Id is the same as your account in the Apple Search Ads UI.
StartDate string: Start getting data from that date.
BackoffFactor double: This factor factor determines the delay increase factor between retryable failures. Valid values are integers between 1 and 20. Default: 5
EndDate string: Data is retrieved until that date (included)
LookbackWindow double: Apple Search Ads uses a 30-day attribution window. However, you may consider smaller values in order to shorten sync durations, at the cost of missing late data attributions. Default: 30

ClientId string: A user identifier for the token request. See \n\nhere\n\n
ClientSecret string: A string that authenticates the user’s setup request. See \n\nhere\n\n
OrgId float64: The identifier of the organization that owns the campaign. Your Org Id is the same as your account in the Apple Search Ads UI.
StartDate string: Start getting data from that date.
BackoffFactor float64: This factor factor determines the delay increase factor between retryable failures. Valid values are integers between 1 and 20. Default: 5
EndDate string: Data is retrieved until that date (included)
LookbackWindow float64: Apple Search Ads uses a 30-day attribution window. However, you may consider smaller values in order to shorten sync durations, at the cost of missing late data attributions. Default: 30

clientId String: A user identifier for the token request. See \n\nhere\n\n
clientSecret String: A string that authenticates the user’s setup request. See \n\nhere\n\n
orgId Double: The identifier of the organization that owns the campaign. Your Org Id is the same as your account in the Apple Search Ads UI.
startDate String: Start getting data from that date.
backoffFactor Double: This factor factor determines the delay increase factor between retryable failures. Valid values are integers between 1 and 20. Default: 5
endDate String: Data is retrieved until that date (included)
lookbackWindow Double: Apple Search Ads uses a 30-day attribution window. However, you may consider smaller values in order to shorten sync durations, at the cost of missing late data attributions. Default: 30

clientId string: A user identifier for the token request. See \n\nhere\n\n
clientSecret string: A string that authenticates the user’s setup request. See \n\nhere\n\n
orgId number: The identifier of the organization that owns the campaign. Your Org Id is the same as your account in the Apple Search Ads UI.
startDate string: Start getting data from that date.
backoffFactor number: This factor factor determines the delay increase factor between retryable failures. Valid values are integers between 1 and 20. Default: 5
endDate string: Data is retrieved until that date (included)
lookbackWindow number: Apple Search Ads uses a 30-day attribution window. However, you may consider smaller values in order to shorten sync durations, at the cost of missing late data attributions. Default: 30

client_id str: A user identifier for the token request. See \n\nhere\n\n
client_secret str: A string that authenticates the user’s setup request. See \n\nhere\n\n
org_id float: The identifier of the organization that owns the campaign. Your Org Id is the same as your account in the Apple Search Ads UI.
start_date str: Start getting data from that date.
backoff_factor float: This factor factor determines the delay increase factor between retryable failures. Valid values are integers between 1 and 20. Default: 5
end_date str: Data is retrieved until that date (included)
lookback_window float: Apple Search Ads uses a 30-day attribution window. However, you may consider smaller values in order to shorten sync durations, at the cost of missing late data attributions. Default: 30

clientId String: A user identifier for the token request. See \n\nhere\n\n
clientSecret String: A string that authenticates the user’s setup request. See \n\nhere\n\n
orgId Number: The identifier of the organization that owns the campaign. Your Org Id is the same as your account in the Apple Search Ads UI.
startDate String: Start getting data from that date.
backoffFactor Number: This factor factor determines the delay increase factor between retryable failures. Valid values are integers between 1 and 20. Default: 5
endDate String: Data is retrieved until that date (included)
lookbackWindow Number: Apple Search Ads uses a 30-day attribution window. However, you may consider smaller values in order to shorten sync durations, at the cost of missing late data attributions. Default: 30

Import

$ pulumi import airbyte:index/sourceAppleSearchAds:SourceAppleSearchAds my_airbyte_source_apple_search_ads ""

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: airbyte airbytehq/terraform-provider-airbyte
License
Notes: This Pulumi package is based on the airbyte Terraform Provider.

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

airbytehq/terraform-provider-airbyte

airbyte.SourceAppleSearchAds

On this page

On this page

Example Usage

Create SourceAppleSearchAds Resource

Constructor syntax

Parameters

Constructor example

SourceAppleSearchAds Resource Properties

Inputs

Outputs

Look up Existing SourceAppleSearchAds Resource

Supporting Types

SourceAppleSearchAdsConfiguration, SourceAppleSearchAdsConfigurationArgs

Import

Package Details

On this page

On this page